isaacscript-common 69.2.0 → 69.3.0

package/dist/index.rollup.d.ts

@@ -14650,6 +14650,18 @@ export declare function parseEntityID(entityID: string): [entityType: EntityType
  */
 export declare function parseEntityTypeVariantString(entityTypeVariantString: string): [entityType: EntityType, variant: int] | undefined;
 
+/**
+ * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+ * undefined if the submitted string was not a proper Semantic Version string.
+ *
+ * https://semver.org/
+ */
+export declare function parseSemanticVersion(versionString: string): {
+    majorVersion: int;
+    minorVersion: int;
+    patchVersion: int;
+} | undefined;
+
 declare class Pause extends Feature {
     private readonly disableInputs;
     private readonly postUpdate;

package/dist/isaacscript-common.lua

@@ -1,6 +1,6 @@
 --[[
 
-isaacscript-common 69.2.0
+isaacscript-common 69.3.0
 
 This is the "isaacscript-common" library, which was created with the IsaacScript tool.
 
@@ -16502,6 +16502,19 @@ function ____exports.getObjectPartialMatch(self, searchText, object)
     assertDefined(nil, value, "Failed to get the object value corresponding to the partial match of: " .. matchingKey)
     return {matchingKey, value}
 end
+function ____exports.parseSemanticVersion(self, versionString)
+    local majorVersionString, minorVersionString, patchVersionString = string.match(versionString, "(%d+).(%d+).(%d+)")
+    if majorVersionString == nil or minorVersionString == nil or patchVersionString == nil then
+        return nil
+    end
+    local majorVersion = tonumber(majorVersionString)
+    local minorVersion = tonumber(minorVersionString)
+    local patchVersion = tonumber(patchVersionString)
+    if majorVersion == nil or minorVersion == nil or patchVersion == nil then
+        return nil
+    end
+    return {majorVersion = majorVersion, minorVersion = minorVersion, patchVersion = patchVersion}
+end
 function ____exports.removeAllCharacters(self, ____string, character)
     return __TS__StringReplaceAll(____string, character, "")
 end

package/dist/src/functions/string.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="isaac-typescript-definitions" />
 export declare function capitalizeFirstLetter(string: string): string;
 /**
  * Helper function to get the closest key from a map based on partial search text. (It only searches
@@ -67,6 +68,17 @@ export declare function getObjectPartialMatch<T>(searchText: string, object: Rec
  * ```
  */
 export declare function getPartialMatch(searchText: string, array: string[]): string | undefined;
+/**
+ * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+ * undefined if the submitted string was not a proper Semantic Version string.
+ *
+ * https://semver.org/
+ */
+export declare function parseSemanticVersion(versionString: string): {
+    majorVersion: int;
+    minorVersion: int;
+    patchVersion: int;
+} | undefined;
 export declare function removeAllCharacters(string: string, character: string): string;
 /**
  * Helper function to remove all of the characters in a string before a given substring. Returns the

package/dist/src/functions/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/functions/string.ts"],"names":[],"mappings":"AAEA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAezB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GACxB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAezB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EAAE,GACd,MAAM,GAAG,SAAS,CAYpB;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR;AAED,8FAA8F;AAC9F,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,UAAU,EAAE,MAAM,EAAE,GACtB,MAAM,CAMR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/functions/string.ts"],"names":[],"mappings":";AAEA,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAU5D;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,UAAU,EAAE,MAAM,EAClB,GAAG,EAAE,WAAW,CAAC,MAAM,EAAE,CAAC,CAAC,GAC1B,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAezB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GACxB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,SAAS,CAezB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EAAE,GACd,MAAM,GAAG,SAAS,CAYpB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,aAAa,EAAE,MAAM,GACtD;IACE,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,EAAE,GAAG,CAAC;CACnB,GACD,SAAS,CAyBZ;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE7E;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,MAAM,CAGR;AAED,8FAA8F;AAC9F,wBAAgB,+BAA+B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,MAAM,EACd,GAAG,UAAU,EAAE,MAAM,EAAE,GACtB,MAAM,CAMR;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAMjE;AAED,gGAAgG;AAChG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAOjE"}

package/dist/src/functions/string.lua

@@ -112,6 +112,23 @@ function ____exports.getObjectPartialMatch(self, searchText, object)
     assertDefined(nil, value, "Failed to get the object value corresponding to the partial match of: " .. matchingKey)
     return {matchingKey, value}
 end
+--- Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+-- undefined if the submitted string was not a proper Semantic Version string.
+-- 
+-- https://semver.org/
+function ____exports.parseSemanticVersion(self, versionString)
+    local majorVersionString, minorVersionString, patchVersionString = string.match(versionString, "(%d+).(%d+).(%d+)")
+    if majorVersionString == nil or minorVersionString == nil or patchVersionString == nil then
+        return nil
+    end
+    local majorVersion = tonumber(majorVersionString)
+    local minorVersion = tonumber(minorVersionString)
+    local patchVersion = tonumber(patchVersionString)
+    if majorVersion == nil or minorVersion == nil or patchVersion == nil then
+        return nil
+    end
+    return {majorVersion = majorVersion, minorVersion = minorVersion, patchVersion = patchVersion}
+end
 function ____exports.removeAllCharacters(self, ____string, character)
     return __TS__StringReplaceAll(____string, character, "")
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isaacscript-common",
-  "version": "69.2.0",
+  "version": "69.3.0",
   "description": "Helper functions and features for IsaacScript mods.",
   "keywords": [
     "isaac",

package/src/functions/string.ts

@@ -134,6 +134,45 @@ export function getPartialMatch(
   return matchingElements[0];
 }
 
+/**
+ * Helper function to parse a Semantic Versioning string into its individual constituents. Returns
+ * undefined if the submitted string was not a proper Semantic Version string.
+ *
+ * https://semver.org/
+ */
+export function parseSemanticVersion(versionString: string):
+  | {
+      majorVersion: int;
+      minorVersion: int;
+      patchVersion: int;
+    }
+  | undefined {
+  const [majorVersionString, minorVersionString, patchVersionString] =
+    string.match(versionString, "(%d+).(%d+).(%d+)");
+
+  if (
+    majorVersionString === undefined ||
+    minorVersionString === undefined ||
+    patchVersionString === undefined
+  ) {
+    return undefined;
+  }
+
+  const majorVersion = tonumber(majorVersionString);
+  const minorVersion = tonumber(minorVersionString);
+  const patchVersion = tonumber(patchVersionString);
+
+  if (
+    majorVersion === undefined ||
+    minorVersion === undefined ||
+    patchVersion === undefined
+  ) {
+    return undefined;
+  }
+
+  return { majorVersion, minorVersion, patchVersion };
+}
+
 export function removeAllCharacters(string: string, character: string): string {
   return string.replaceAll(character, "");
 }