@vicin/sigil 2.1.0 → 2.2.0

package/dist/index.js

@@ -6,25 +6,24 @@ var cuid2 = require('@paralleldrive/cuid2');
 var OPTIONS = {
   labelValidation: null,
   skipLabelInheritanceCheck: false,
-  autofillLabels: false
+  autofillLabels: true
 };
 var updateSigilOptions = (opts) => {
-  if (opts.autofillLabels) {
+  if ("autofillLabels" in opts) {
     if (typeof opts.autofillLabels !== "boolean")
       throw new Error("'updateSigilOptions.autofillLabels' must be boolean");
     OPTIONS.autofillLabels = opts.autofillLabels;
   }
-  if (opts.skipLabelInheritanceCheck) {
+  if ("skipLabelInheritanceCheck" in opts) {
     if (typeof opts.skipLabelInheritanceCheck !== "boolean")
       throw new Error("'updateSigilOptions.skipLabelInheritanceCheck' must be boolean");
     OPTIONS.skipLabelInheritanceCheck = opts.skipLabelInheritanceCheck;
   }
-  if (opts.labelValidation) {
-    if (opts.labelValidation !== null && typeof opts.labelValidation !== "function" && !(opts.labelValidation instanceof RegExp))
-      throw new Error(
-        "'updateSigilOptions.labelValidation' must be null, function or regex expression"
-      );
-    OPTIONS.labelValidation = opts.labelValidation;
+  if ("labelValidation" in opts) {
+    const val = opts.labelValidation;
+    if (val !== null && typeof val !== "function" && !(val instanceof RegExp))
+      throw new Error("'updateSigilOptions.labelValidation' must be null, function or RegExp");
+    OPTIONS.labelValidation = val != null ? val : null;
   }
 };
 var DEFAULT_LABEL_REGEX = /^@[\w-]+(?:\/[\w-]+)*\.[A-Z][A-Za-z0-9]*$/;
@@ -35,47 +34,50 @@ var __SIGIL_BASE__ = /* @__PURE__ */ Symbol.for("@Sigil.__SIGIL_BASE__");
 var __DECORATED__ = /* @__PURE__ */ Symbol.for("@Sigil.__DECORATED__");
 var __INHERITANCE_CHECKED__ = /* @__PURE__ */ Symbol.for("@Sigil.__INHERITANCE_CHECKED__");
 var __LABEL__ = /* @__PURE__ */ Symbol.for("@Sigil.__LABEL__");
+var __EFFECTIVE_LABEL__ = /* @__PURE__ */ Symbol.for("@Sigil.__EFFECTIVE_LABEL__");
 var __LABEL_LINEAGE__ = /* @__PURE__ */ Symbol.for("@Sigil.__LABEL_LINEAGE__");
 var __LABEL_SET__ = /* @__PURE__ */ Symbol.for("@Sigil.__LABEL_SET__");
-
-// src/core/constants.ts
-var __DEV__ = typeof process !== "undefined" && process.env.NODE_ENV === "development";
-
-// src/core/helpers.ts
-function decorateCtor(ctor, label, isMixin = false) {
-  if (isDecorated(ctor))
-    throw new Error(
-      `Constructor ${ctor} is already decorated. if you are using 'withSigilTyped()' & '@WithSigil()' at the same time remove one of them.`
-    );
+function decorateCtor(ctor, label, runtime) {
+  if (process.env.NODE_ENV !== "production") {
+    if (isDecorated(ctor))
+      throw new Error(
+        `Constructor ${ctor} is already decorated. if you are using 'withSigilTyped()' & '@WithSigil()' at the same time remove one of them.`
+      );
+  }
   Object.defineProperty(ctor, __LABEL__, {
     value: label,
-    configurable: false,
+    configurable: true,
     enumerable: false,
     writable: false
   });
+  if (!(runtime == null ? void 0 : runtime.isInheritanceCheck))
+    Object.defineProperty(ctor, __EFFECTIVE_LABEL__, {
+      value: label,
+      configurable: true,
+      enumerable: false,
+      writable: false
+    });
   const parent = Object.getPrototypeOf(ctor);
   const parentChain = parent && parent[__LABEL_LINEAGE__] ? parent[__LABEL_LINEAGE__] : [];
-  const ctorChain = isMixin && label !== "Sigil" ? ["Sigil", ...parentChain, label] : [...parentChain, label];
+  const ctorChain = (runtime == null ? void 0 : runtime.isMixin) && label !== "Sigil" ? ["Sigil", ...parentChain, label] : [...parentChain, label];
   Object.defineProperty(ctor, __LABEL_LINEAGE__, {
     value: ctorChain,
-    configurable: false,
+    configurable: true,
     enumerable: false,
     writable: false
   });
   Object.defineProperty(ctor, __LABEL_SET__, {
     value: new Set(ctorChain),
-    configurable: false,
+    configurable: true,
     enumerable: false,
     writable: false
   });
-  markDecorated(ctor);
+  if (!(runtime == null ? void 0 : runtime.isInheritanceCheck)) markDecorated(ctor);
 }
 function checkInheritance(ctor, opts) {
   var _a, _b;
-  const skipLabelInheritanceCheck = (_a = opts == null ? void 0 : opts.skipLabelInheritanceCheck) != null ? _a : OPTIONS.skipLabelInheritanceCheck;
-  const autofillLabels = (_b = opts == null ? void 0 : opts.autofillLabels) != null ? _b : OPTIONS.autofillLabels;
-  if (!isSigilCtor(ctor)) return;
-  if (isInheritanceChecked(ctor) || skipLabelInheritanceCheck) return;
+  if (isInheritanceChecked(ctor) || ((_a = opts == null ? void 0 : opts.skipLabelInheritanceCheck) != null ? _a : OPTIONS.skipLabelInheritanceCheck))
+    return;
   const ctors = [ctor];
   let ancestor = Object.getPrototypeOf(ctor);
   while (isSigilCtor(ancestor)) {
@@ -86,16 +88,16 @@ function checkInheritance(ctor, opts) {
   for (let i = ctors.length - 1; i >= 0; i--) {
     const ctor2 = ctors[i];
     if (!ctor2) continue;
-    let label = ctor2.SigilLabel;
+    let label = ctor2[__LABEL__];
     if (labelOwner.has(label)) {
-      if (isDecorated(ctor2) || !autofillLabels) {
-        const ancestorName = labelOwner.get(label);
-        throw new Error(
-          `[Sigil Error] Class "${ctor2.name}" re-uses Sigil label "${label}" from ancestor "${ancestorName}". Each Sigil subclass must use a unique label. Did you forget to use "WithSigil(newLabel)" on the subclass?`
-        );
+      if (process.env.NODE_ENV !== "production") {
+        if (isDecorated(ctor2) || !((_b = opts == null ? void 0 : opts.autofillLabels) != null ? _b : OPTIONS.autofillLabels))
+          throw new Error(
+            `[Sigil Error] Class "${ctor2.name}" re-uses Sigil label "${label}" from ancestor "${labelOwner.get(label)}". Each Sigil subclass must use a unique label. Did you forget to use "WithSigil(newLabel)" on the subclass?`
+          );
       }
       label = generateRandomLabel();
-      decorateCtor(ctor2, label);
+      decorateCtor(ctor2, label, { isInheritanceCheck: true });
     }
     labelOwner.set(label, ctor2.name);
   }
@@ -108,10 +110,12 @@ function verifyLabel(label, opts) {
     let valid;
     if (labelValidation instanceof RegExp) valid = labelValidation.test(label);
     else valid = labelValidation(label);
-    if (!valid)
-      throw new Error(
-        `[Sigil] Invalid identity label "${label}". Make sure that supplied label matches validation regex or function.`
-      );
+    if (process.env.NODE_ENV !== "production") {
+      if (!valid)
+        throw new Error(
+          `[Sigil] Invalid identity label "${label}". Make sure that supplied label matches validation regex or function.`
+        );
+    }
   }
 }
 function generateRandomLabel() {
@@ -180,7 +184,7 @@ function getConstructor(obj) {
 
 // src/core/mixin.ts
 function Sigilify(Base, label, opts) {
-  if (isSigilCtor(Base)) throw new Error(`[Sigil Error] 'Sigilify(${label})' already siglified.`);
+  if (isSigilCtor(Base)) throw new Error(`[Sigil Error] 'Sigilify(${label})' already sigilified.`);
   let l;
   if (label) {
     verifyLabel(label, opts);
@@ -188,11 +192,18 @@ function Sigilify(Base, label, opts) {
   } else l = generateRandomLabel();
   class Sigilified extends Base {
     /**
-     * Class-level human-readable label constant for this sigil constructor.
+     * Class-level identity label constant for this sigil constructor.
      */
     static get SigilLabel() {
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       return this[__LABEL__];
     }
+    /**
+     * Class-level human-readable label constant for this sigil constructor, last passed label in 'Sigil' chain by developer.
+     */
+    static get SigilEffectiveLabel() {
+      return this[__EFFECTIVE_LABEL__];
+    }
     /**
      * Copy of the linearized sigil type label chain for the current constructor.
      *
@@ -202,6 +213,7 @@ function Sigilify(Base, label, opts) {
      */
     static get SigilLabelLineage() {
       var _a;
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       return [...(_a = this[__LABEL_LINEAGE__]) != null ? _a : []];
     }
     /**
@@ -212,6 +224,7 @@ function Sigilify(Base, label, opts) {
      * @returns A Readonly Set of labels that represent the type lineage.
      */
     static get SigilLabelSet() {
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       const set = /* @__PURE__ */ new Set();
       for (const s of this[__LABEL_SET__]) set.add(s);
       return set;
@@ -222,11 +235,11 @@ function Sigilify(Base, label, opts) {
         Object.setPrototypeOf(this, new.target.prototype);
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
+        if (process.env.NODE_ENV !== "production")
           throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
         return;
       }
-      if (__DEV__) checkInheritance(ctor);
+      checkInheritance(ctor);
     }
     /**
      * Runtime predicate indicating whether `obj` is an instance produced by a sigil class.
@@ -305,19 +318,33 @@ function Sigilify(Base, label, opts) {
       return !!otherLineage && thisLineage.every((s, i) => s === otherLineage[i]);
     }
     /**
-     * Returns the human-readable sigil label of this instance's constructor.
+     * Returns the identity sigil label of this instance's constructor.
      *
-     * @returns The label string (e.g. '@scope/pkg.ClassName') or '@Sigil.unknown' in DEV when constructor is missing.
+     * @returns The label string if passed (e.g. '@scope/pkg.ClassName'), random label if not passed (e.g. '@Sigil.auto-dq62ib6jnvmmlfbjhxh2937h') or '@Sigil.unknown' if constructor is missing.
      */
     getSigilLabel() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return "@Sigil.unknown";
       }
       return ctor.SigilLabel;
     }
+    /**
+     * Returns the human-readable sigil label of this instance's constructor.
+     *
+     * @returns The last passed label string (e.g. '@scope/pkg.ClassName') or '@Sigil.unknown' if constructor is missing.
+     */
+    getSigilEffectiveLabel() {
+      const ctor = getConstructor(this);
+      if (!ctor) {
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
+        return "@Sigil.unknown";
+      }
+      return ctor.SigilEffectiveLabel;
+    }
     /**
      * Returns a copy of the sigil type label lineage for this instance's constructor.
      *
@@ -326,8 +353,8 @@ function Sigilify(Base, label, opts) {
     getSigilLabelLineage() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return ["@Sigil.unknown"];
       }
       return ctor.SigilLabelLineage;
@@ -340,20 +367,20 @@ function Sigilify(Base, label, opts) {
     getSigilLabelSet() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return /* @__PURE__ */ new Set(["@Sigil.unknown"]);
       }
       return ctor.SigilLabelSet;
     }
   }
-  decorateCtor(Sigilified, l, true);
+  decorateCtor(Sigilified, l, { isMixin: true });
   markSigil(Sigilified);
   markSigilBase(Sigilified);
   return Sigilified;
 }
 function SigilifyAbstract(Base, label, opts) {
-  if (isSigilCtor(Base)) throw new Error(`[Sigil Error] 'Sigilify(${label})' already siglified.`);
+  if (isSigilCtor(Base)) throw new Error(`[Sigil Error] 'Sigilify(${label})' already sigilified.`);
   let l;
   if (label) {
     verifyLabel(label, opts);
@@ -361,11 +388,18 @@ function SigilifyAbstract(Base, label, opts) {
   } else l = generateRandomLabel();
   class Sigilified extends Base {
     /**
-     * Class-level human-readable label constant for this sigil constructor.
+     * Class-level identity label constant for this sigil constructor.
      */
     static get SigilLabel() {
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       return this[__LABEL__];
     }
+    /**
+     * Class-level human-readable label constant for this sigil constructor, last passed label in 'Sigil' chain by developer.
+     */
+    static get SigilEffectiveLabel() {
+      return this[__EFFECTIVE_LABEL__];
+    }
     /**
      * Copy of the linearized sigil type label chain for the current constructor.
      *
@@ -375,6 +409,7 @@ function SigilifyAbstract(Base, label, opts) {
      */
     static get SigilLabelLineage() {
       var _a;
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       return [...(_a = this[__LABEL_LINEAGE__]) != null ? _a : []];
     }
     /**
@@ -385,6 +420,7 @@ function SigilifyAbstract(Base, label, opts) {
      * @returns A Readonly Set of labels that represent the type lineage.
      */
     static get SigilLabelSet() {
+      if (!isInheritanceChecked(this)) checkInheritance(this);
       const set = /* @__PURE__ */ new Set();
       for (const s of this[__LABEL_SET__]) set.add(s);
       return set;
@@ -395,11 +431,11 @@ function SigilifyAbstract(Base, label, opts) {
         Object.setPrototypeOf(this, new.target.prototype);
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
+        if (process.env.NODE_ENV !== "production")
           throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
         return;
       }
-      if (__DEV__) checkInheritance(ctor);
+      checkInheritance(ctor);
     }
     /**
      * Runtime predicate indicating whether `obj` is an instance produced by a sigil class.
@@ -427,7 +463,7 @@ function SigilifyAbstract(Base, label, opts) {
      */
     static isOfType(other) {
       var _a;
-      if (!isSigilInstance(other) || !isSigilCtor(this)) return false;
+      if (!isSigilInstance(other)) return false;
       const otherSet = (_a = getConstructor(other)) == null ? void 0 : _a[__LABEL_SET__];
       const thisType = this[__LABEL__];
       return !!otherSet && otherSet.has(thisType);
@@ -446,7 +482,7 @@ function SigilifyAbstract(Base, label, opts) {
      */
     static isOfTypeStrict(other) {
       var _a;
-      if (!isSigilInstance(other) || !isSigilCtor(this)) return false;
+      if (!isSigilInstance(other)) return false;
       const otherLineage = (_a = getConstructor(other)) == null ? void 0 : _a[__LABEL_LINEAGE__];
       const thisLineage = this[__LABEL_LINEAGE__];
       return !!otherLineage && thisLineage.every((s, i) => s === otherLineage[i]);
@@ -463,7 +499,7 @@ function SigilifyAbstract(Base, label, opts) {
      */
     isOfType(other) {
       var _a;
-      if (!isSigilInstance(other) || !isSigilInstance(this)) return false;
+      if (!isSigilInstance(other)) return false;
       const otherSet = (_a = getConstructor(other)) == null ? void 0 : _a[__LABEL_SET__];
       const thisType = getConstructor(this)[__LABEL__];
       return !!otherSet && otherSet.has(thisType);
@@ -480,25 +516,39 @@ function SigilifyAbstract(Base, label, opts) {
      */
     isOfTypeStrict(other) {
       var _a, _b;
-      if (!isSigilInstance(other) || !isSigilInstance(this)) return false;
+      if (!isSigilInstance(other)) return false;
       const otherLineage = (_a = getConstructor(other)) == null ? void 0 : _a[__LABEL_LINEAGE__];
       const thisLineage = (_b = getConstructor(this)) == null ? void 0 : _b[__LABEL_LINEAGE__];
       return !!otherLineage && thisLineage.every((s, i) => s === otherLineage[i]);
     }
     /**
-     * Returns the human-readable sigil label of this instance's constructor.
+     * Returns the identity sigil label of this instance's constructor.
      *
-     * @returns The label string (e.g. '@scope/pkg.ClassName') or '@Sigil.unknown' in DEV when constructor is missing.
+     * @returns The label string if passed (e.g. '@scope/pkg.ClassName'), random label if not passed (e.g. '@Sigil.auto-dq62ib6jnvmmlfbjhxh2937h') or '@Sigil.unknown' if constructor is missing.
      */
     getSigilLabel() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return "@Sigil.unknown";
       }
       return ctor.SigilLabel;
     }
+    /**
+     * Returns the human-readable sigil label of this instance's constructor.
+     *
+     * @returns The last passed label string (e.g. '@scope/pkg.ClassName') or '@Sigil.unknown' if constructor is missing.
+     */
+    getSigilEffectiveLabel() {
+      const ctor = getConstructor(this);
+      if (!ctor) {
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
+        return "@Sigil.unknown";
+      }
+      return ctor.SigilEffectiveLabel;
+    }
     /**
      * Returns a copy of the sigil type label lineage for this instance's constructor.
      *
@@ -507,8 +557,8 @@ function SigilifyAbstract(Base, label, opts) {
     getSigilLabelLineage() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return ["@Sigil.unknown"];
       }
       return ctor.SigilLabelLineage;
@@ -521,14 +571,14 @@ function SigilifyAbstract(Base, label, opts) {
     getSigilLabelSet() {
       const ctor = getConstructor(this);
       if (!ctor) {
-        if (__DEV__)
-          throw new Error(`[Sigil Error] 'Sigilify(${label})' instance without constructor`);
+        if (process.env.NODE_ENV !== "production")
+          throw new Error(`[Sigil Error] Sigil class instance without constructor`);
         return /* @__PURE__ */ new Set(["@Sigil.unknown"]);
       }
       return ctor.SigilLabelSet;
     }
   }
-  decorateCtor(Sigilified, l, true);
+  decorateCtor(Sigilified, l, { isMixin: true });
   markSigil(Sigilified);
   markSigilBase(Sigilified);
   return Sigilified;
@@ -553,7 +603,7 @@ function WithSigil(label, opts) {
         `[Sigil Error] 'WithSigil' decorator accept only Sigil classes but used on class ${value.name}`
       );
     decorateCtor(value, l);
-    if (__DEV__) checkInheritance(value, opts);
+    checkInheritance(value, opts);
   };
 }
 
@@ -571,7 +621,7 @@ function withSigil(Class, label, opts) {
   } else l = generateRandomLabel();
   const ctor = Class;
   decorateCtor(ctor, l);
-  if (__DEV__) checkInheritance(ctor, opts);
+  checkInheritance(ctor, opts);
   return Class;
 }
 function withSigilTyped(Class, label, opts) {
@@ -587,7 +637,7 @@ function withSigilTyped(Class, label, opts) {
   } else l = generateRandomLabel();
   const ctor = Class;
   decorateCtor(ctor, l);
-  if (__DEV__) checkInheritance(ctor, opts);
+  checkInheritance(ctor, opts);
   return Class;
 }