@canonical/utils 0.7.1-experimental.0 → 0.9.0-experimental.0

package/dist/esm/casing.js

@@ -42,9 +42,25 @@ const toCamelCase = (s) => {
         .replaceAll("_", "")
         .replaceAll(" ", "");
 };
+/**
+ * Check if a string is in PascalCase.
+ * @param s - The string to check
+ * @returns True if the string is in PascalCase, false otherwise.
+ * @example
+ * isPascalCase("MyComponent") // true
+ * isPascalCase("myComponent") // false
+ */
+const isPascalCase = (s) => {
+    // A simple regular expression that requires:
+    // - the string to start with an uppercase letter
+    // - followed by zero or more lowercase letters or digits,
+    // - then zero or more groups that start with an uppercase letter followed by zero or more lowercase letters or digits.
+    return /^[A-Z][a-z0-9]*(?:[A-Z][a-z0-9]*)*$/.test(s);
+};
 export default {
     toPascalCase,
     toKebabCase,
     toCamelCase,
+    isPascalCase,
 };
 //# sourceMappingURL=casing.js.map

package/dist/esm/casing.js.map

@@ -1 +1 @@
-{"version":3,"file":"casing.js","sourceRoot":"","sources":["../../src/casing.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,YAAY,GAAG,CAAC,CAAS,EAAU,EAAE;IACzC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAElC,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,CAAS,EAAU,EAAE;IACxC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,OAAO,CAAC;SACL,IAAI,EAAE;SACN,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,WAAW,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,CAAS,EAAU,EAAE;IACxC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,OAAO,CAAC;SACL,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;SAC/C,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF,eAAe;IACb,YAAY;IACZ,WAAW;IACX,WAAW;CACZ,CAAC"}
+{"version":3,"file":"casing.js","sourceRoot":"","sources":["../../src/casing.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,YAAY,GAAG,CAAC,CAAS,EAAU,EAAE;IACzC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAElC,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,CAAS,EAAU,EAAE;IACxC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,OAAO,CAAC;SACL,IAAI,EAAE;SACN,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC;SACtC,WAAW,EAAE,CAAC;AACnB,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,CAAS,EAAU,EAAE;IACxC,IAAI,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IAElB,OAAO,CAAC;SACL,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;SAC/C,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC;SACnB,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;AACzB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,YAAY,GAAG,CAAC,CAAS,EAAW,EAAE;IAC1C,6CAA6C;IAC7C,iDAAiD;IACjD,0DAA0D;IAC1D,uHAAuH;IACvH,OAAO,qCAAqC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,eAAe;IACb,YAAY;IACZ,WAAW;IACX,WAAW;IACX,YAAY;CACb,CAAC"}

package/dist/esm/index.js

@@ -1,4 +1,5 @@
 export { default as debounce } from "./debounce.js";
 export { default as throttle } from "./throttle.js";
 export { default as casing } from "./casing.js";
+export { default as invariant } from "./invariant.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/invariant.js

@@ -0,0 +1,38 @@
+/**
+ * Asserts that the given condition is truthy.
+ *
+ * @remarks
+ * This is a minimalist invariant function. It throws an error with the provided message
+ * (or a default one) if the condition is falsy. Unlike a more basic implementation, this version
+ * supports lazy evaluation of the message (if provided as a function) and allows a custom prefix to be added.
+ *
+ * Tiny-invariant includes additional branches to:
+ * - Check the runtime environment (development vs. production) and strip detailed messages in production.
+ *
+ * If you need these extra features (e.g., for optimized production bundles), tiny-invariant may
+ * be a better choice. However, if simplicity and minimal code are your priorities, this version
+ * may suffice.
+ *
+ * @param condition - The condition to assert. If falsy, an error is thrown.
+ * @param message - Optional error message or a function that returns an error message. If not provided, a default message is used.
+ * @param prefix - Optional prefix for the error message. Defaults to 'Invariant violation'.
+ *
+ * @throws {Error} If the condition is falsy.
+ *
+ * @example
+ * ```typescript
+ * const value: string | undefined = getValue();
+ * invariant(typeof value === 'string', 'Expected value to be a string');
+ * // After this assertion, TypeScript narrows `value` to `string`.
+ *
+ * // With a custom prefix and lazy evaluation:
+ * invariant(value !== null, () => `Value should not be null, got ${value}`, 'Type Error');
+ * ```
+ */
+export default (condition, message, prefix = "Invariant violation") => {
+    if (!condition) {
+        const resolvedMessage = typeof message === "function" ? message() : message;
+        throw new Error(resolvedMessage ? `${prefix}: ${resolvedMessage}` : prefix);
+    }
+};
+//# sourceMappingURL=invariant.js.map

package/dist/esm/invariant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invariant.js","sourceRoot":"","sources":["../../src/invariant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAe,CACb,SAAkB,EAClB,OAAiC,EACjC,MAAM,GAAG,qBAAqB,EACX,EAAE;IACrB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,eAAe,GAAG,OAAO,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QAC5E,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,eAAe,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC,CAAC"}

package/dist/types/casing.d.ts

@@ -2,6 +2,7 @@ declare const _default: {
     toPascalCase: (s: string) => string;
     toKebabCase: (s: string) => string;
     toCamelCase: (s: string) => string;
+    isPascalCase: (s: string) => boolean;
 };
 export default _default;
 //# sourceMappingURL=casing.d.ts.map

package/dist/types/casing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"casing.d.ts","sourceRoot":"","sources":["../../src/casing.ts"],"names":[],"mappings":";sBAOyB,MAAM,KAAG,MAAM;qBAehB,MAAM,KAAG,MAAM;qBAgBf,MAAM,KAAG,MAAM;;AAUvC,wBAIE"}
+{"version":3,"file":"casing.d.ts","sourceRoot":"","sources":["../../src/casing.ts"],"names":[],"mappings":";sBAOyB,MAAM,KAAG,MAAM;qBAehB,MAAM,KAAG,MAAM;qBAgBf,MAAM,KAAG,MAAM;sBAkBd,MAAM,KAAG,OAAO;;AAQzC,wBAKE"}

package/dist/types/index.d.ts

@@ -1,4 +1,5 @@
 export { default as debounce } from "./debounce.js";
 export { default as throttle } from "./throttle.js";
 export { default as casing } from "./casing.js";
+export { default as invariant } from "./invariant.js";
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/types/invariant.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Asserts that the given condition is truthy.
+ *
+ * @remarks
+ * This is a minimalist invariant function. It throws an error with the provided message
+ * (or a default one) if the condition is falsy. Unlike a more basic implementation, this version
+ * supports lazy evaluation of the message (if provided as a function) and allows a custom prefix to be added.
+ *
+ * Tiny-invariant includes additional branches to:
+ * - Check the runtime environment (development vs. production) and strip detailed messages in production.
+ *
+ * If you need these extra features (e.g., for optimized production bundles), tiny-invariant may
+ * be a better choice. However, if simplicity and minimal code are your priorities, this version
+ * may suffice.
+ *
+ * @param condition - The condition to assert. If falsy, an error is thrown.
+ * @param message - Optional error message or a function that returns an error message. If not provided, a default message is used.
+ * @param prefix - Optional prefix for the error message. Defaults to 'Invariant violation'.
+ *
+ * @throws {Error} If the condition is falsy.
+ *
+ * @example
+ * ```typescript
+ * const value: string | undefined = getValue();
+ * invariant(typeof value === 'string', 'Expected value to be a string');
+ * // After this assertion, TypeScript narrows `value` to `string`.
+ *
+ * // With a custom prefix and lazy evaluation:
+ * invariant(value !== null, () => `Value should not be null, got ${value}`, 'Type Error');
+ * ```
+ */
+declare const _default: (condition: unknown, message?: string | (() => string), prefix?: string) => asserts condition;
+export default _default;
+//# sourceMappingURL=invariant.d.ts.map

package/dist/types/invariant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invariant.d.ts","sourceRoot":"","sources":["../../src/invariant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;oCAEU,OAAO,YACR,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,sBAEhC,QAAQ,SAAS;AAJpB,wBASE"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@canonical/utils",
   "description": "Standard utility functions for Canonical's Web Engineering team",
-  "version": "0.7.1-experimental.0",
+  "version": "0.9.0-experimental.0",
   "type": "module",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -42,5 +42,5 @@
     "@canonical/typescript-config-base": "^0.4.0-experimental.0",
     "typescript": "^5.7.2"
   },
-  "gitHead": "636cd2e447a1f2bb67e636169d6cbb5171e6fca6"
+  "gitHead": "5d06233e70975e9ccc475c2d13de7e2ff8769c44"
 }