@kyco-utils/enums 0.1.3 → 0.2.0

package/README.md

@@ -1,7 +1,26 @@
 # @kyco-utils/enums
 
-A set of utilities for TS projects.
+Shared runtime enums and their [Zod](https://zod.dev) schemas.
+
+## Install
+
+```sh
+pnpm add @kyco-utils/enums zod
+```
+
+Requires `zod` v4 as a peer dependency. ESM only.
+
+## Usage
+
+```ts
+import { ColorMode, zColorMode } from '@kyco-utils/enums'
+
+const mode: ColorMode = ColorMode.DARK // 'dark'
+zColorMode.safeParse('blue').success // false
+```
+
+See the [API reference](https://kyco.github.io/kyco-utils/api/@kyco-utils/enums) for all exports.
 
 ## License
 
-[MIT](LICENSE)
+[MIT](https://github.com/kyco/kyco-utils/blob/main/LICENSE)

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import * as z from "zod";
 /**
- * Supported color modes available.
+ * Color modes a user can choose for the UI.
  *
  * @enum
  * @example
@@ -16,10 +16,9 @@ export declare const ColorMode: {
   readonly DARK: 'dark';
 };
 /**
- * Zod schema for {@link ColorMode}.
+ * Zod schema that validates a {@link ColorMode}.
  *
  * @group Schemas
- *
  * @example
  * ```ts
  * import { zColorMode } from '@kyco-utils/enums'
@@ -29,14 +28,15 @@ export declare const ColorMode: {
  * ```
  */
 export declare const zColorMode: z.ZodEnum<{
-  dark: "dark";
-  light: "light";
-  system: "system";
+  readonly SYSTEM: 'system';
+  readonly LIGHT: 'light';
+  readonly DARK: 'dark';
 }>;
 export type ColorMode = z.infer<typeof zColorMode>;
 /**
- * Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,
- * i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.
+ * Locales supported across kyco-utils, as [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag)
+ * language tags in the form `{language}-{region}`: an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+ * language code and an [ISO 3166-1](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) region code.
  *
  * @enum
  * @example
@@ -51,10 +51,9 @@ export declare const UserLocale: {
   readonly DE_DE: 'de-DE';
 };
 /**
- * Zod schema for {@link UserLocale}.
+ * Zod schema that validates a {@link UserLocale}.
  *
  * @group Schemas
- *
  * @example
  * ```ts
  * import { zUserLocale } from '@kyco-utils/enums'

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import * as z from "zod";
 // src/index.ts
 /**
-* Supported color modes available.
+* Color modes a user can choose for the UI.
 *
 * @enum
 * @example
@@ -17,10 +17,9 @@ const ColorMode = {
 	DARK: "dark"
 };
 /**
-* Zod schema for {@link ColorMode}.
+* Zod schema that validates a {@link ColorMode}.
 *
 * @group Schemas
-*
 * @example
 * ```ts
 * import { zColorMode } from '@kyco-utils/enums'
@@ -29,14 +28,11 @@ const ColorMode = {
 * zColorMode.safeParse('blue').success // false
 * ```
 */
-const zColorMode = z.enum([
-	ColorMode.SYSTEM,
-	ColorMode.LIGHT,
-	ColorMode.DARK
-]);
+const zColorMode = z.enum(ColorMode);
 /**
-* Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,
-* i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.
+* Locales supported across kyco-utils, as [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag)
+* language tags in the form `{language}-{region}`: an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
+* language code and an [ISO 3166-1](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) region code.
 *
 * @enum
 * @example
@@ -51,10 +47,9 @@ const UserLocale = {
 	DE_DE: "de-DE"
 };
 /**
-* Zod schema for {@link UserLocale}.
+* Zod schema that validates a {@link UserLocale}.
 *
 * @group Schemas
-*
 * @example
 * ```ts
 * import { zUserLocale } from '@kyco-utils/enums'

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import * as z from 'zod'\n\n// -------------------------------------------------------\n\n/**\n * Supported color modes available.\n *\n * @enum\n * @example\n * ```ts\n * import { ColorMode } from '@kyco-utils/enums'\n *\n * const mode: ColorMode = ColorMode.DARK // 'dark'\n * ```\n */\nexport const ColorMode = {\n  SYSTEM: 'system',\n  LIGHT: 'light',\n  DARK: 'dark',\n} as const\n\n/**\n * Zod schema for {@link ColorMode}.\n *\n * @group Schemas\n *\n * @example\n * ```ts\n * import { zColorMode } from '@kyco-utils/enums'\n *\n * zColorMode.parse('dark') // 'dark'\n * zColorMode.safeParse('blue').success // false\n * ```\n */\nexport const zColorMode = z.enum([ColorMode.SYSTEM, ColorMode.LIGHT, ColorMode.DARK] as const)\n\nexport type ColorMode = z.infer<typeof zColorMode>\n\n// -------------------------------------------------------\n\n/**\n * Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,\n * i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.\n *\n * @enum\n * @example\n * ```ts\n * import { UserLocale } from '@kyco-utils/enums'\n *\n * const locale: UserLocale = UserLocale.DE_DE // 'de-DE'\n * ```\n */\nexport const UserLocale = {\n  // @locale-updates\n  EN_GB: 'en-GB',\n  DE_DE: 'de-DE',\n} as const\n\n/**\n * Zod schema for {@link UserLocale}.\n *\n * @group Schemas\n *\n * @example\n * ```ts\n * import { zUserLocale } from '@kyco-utils/enums'\n *\n * zUserLocale.parse('en-GB') // 'en-GB'\n * zUserLocale.safeParse('fr-FR').success // false\n * ```\n */\nexport const zUserLocale = z.enum(UserLocale)\n\nexport type UserLocale = z.infer<typeof zUserLocale>\n\n// -------------------------------------------------------\n"],"mappings":";;;;;;;;;;;;;AAeA,MAAa,YAAY;CACvB,QAAQ;CACR,OAAO;CACP,MAAM;AACR;;;;;;;;;;;;;;AAeA,MAAa,aAAa,EAAE,KAAK;CAAC,UAAU;CAAQ,UAAU;CAAO,UAAU;AAAI,CAAU;;;;;;;;;;;;;AAkB7F,MAAa,aAAa;CAExB,OAAO;CACP,OAAO;AACT;;;;;;;;;;;;;;AAeA,MAAa,cAAc,EAAE,KAAK,UAAU"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import * as z from 'zod'\n\n// -------------------------------------------------------\n\n/**\n * Color modes a user can choose for the UI.\n *\n * @enum\n * @example\n * ```ts\n * import { ColorMode } from '@kyco-utils/enums'\n *\n * const mode: ColorMode = ColorMode.DARK // 'dark'\n * ```\n */\nexport const ColorMode = {\n  SYSTEM: 'system',\n  LIGHT: 'light',\n  DARK: 'dark',\n} as const\n\n/**\n * Zod schema that validates a {@link ColorMode}.\n *\n * @group Schemas\n * @example\n * ```ts\n * import { zColorMode } from '@kyco-utils/enums'\n *\n * zColorMode.parse('dark') // 'dark'\n * zColorMode.safeParse('blue').success // false\n * ```\n */\nexport const zColorMode = z.enum(ColorMode)\n\nexport type ColorMode = z.infer<typeof zColorMode>\n\n// -------------------------------------------------------\n\n/**\n * Locales supported across kyco-utils, as [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag)\n * language tags in the form `{language}-{region}`: an [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)\n * language code and an [ISO 3166-1](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) region code.\n *\n * @enum\n * @example\n * ```ts\n * import { UserLocale } from '@kyco-utils/enums'\n *\n * const locale: UserLocale = UserLocale.DE_DE // 'de-DE'\n * ```\n */\nexport const UserLocale = {\n  // @locale-updates\n  EN_GB: 'en-GB',\n  DE_DE: 'de-DE',\n} as const\n\n/**\n * Zod schema that validates a {@link UserLocale}.\n *\n * @group Schemas\n * @example\n * ```ts\n * import { zUserLocale } from '@kyco-utils/enums'\n *\n * zUserLocale.parse('en-GB') // 'en-GB'\n * zUserLocale.safeParse('fr-FR').success // false\n * ```\n */\nexport const zUserLocale = z.enum(UserLocale)\n\nexport type UserLocale = z.infer<typeof zUserLocale>\n\n// -------------------------------------------------------\n"],"mappings":";;;;;;;;;;;;;AAeA,MAAa,YAAY;CACvB,QAAQ;CACR,OAAO;CACP,MAAM;AACR;;;;;;;;;;;;;AAcA,MAAa,aAAa,EAAE,KAAK,SAAS;;;;;;;;;;;;;;AAmB1C,MAAa,aAAa;CAExB,OAAO;CACP,OAAO;AACT;;;;;;;;;;;;;AAcA,MAAa,cAAc,EAAE,KAAK,UAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kyco-utils/enums",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Shared runtime enums and Zod schemas for kyco-utils.",
   "type": "module",
   "sideEffects": false,
@@ -17,19 +17,10 @@
   "exports": {
     ".": {
       "@kyco-utils/source": "./src/index.ts",
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
     }
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.cts",
   "peerDependencies": {
     "zod": "^4.0.0"
   },
@@ -43,7 +34,6 @@
   "scripts": {
     "build": "vp pack",
     "dev": "vp pack --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "biome check ."
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/index.cjs

@@ -1,95 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-// \0rolldown/runtime.js
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-let zod = require("zod");
-zod = __toESM(zod, 1);
-// src/index.ts
-/**
-* Supported color modes available.
-*
-* @enum
-* @example
-* ```ts
-* import { ColorMode } from '@kyco-utils/enums'
-*
-* const mode: ColorMode = ColorMode.DARK // 'dark'
-* ```
-*/
-const ColorMode = {
-	SYSTEM: "system",
-	LIGHT: "light",
-	DARK: "dark"
-};
-/**
-* Zod schema for {@link ColorMode}.
-*
-* @group Schemas
-*
-* @example
-* ```ts
-* import { zColorMode } from '@kyco-utils/enums'
-*
-* zColorMode.parse('dark') // 'dark'
-* zColorMode.safeParse('blue').success // false
-* ```
-*/
-const zColorMode = zod.enum([
-	ColorMode.SYSTEM,
-	ColorMode.LIGHT,
-	ColorMode.DARK
-]);
-/**
-* Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,
-* i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.
-*
-* @enum
-* @example
-* ```ts
-* import { UserLocale } from '@kyco-utils/enums'
-*
-* const locale: UserLocale = UserLocale.DE_DE // 'de-DE'
-* ```
-*/
-const UserLocale = {
-	EN_GB: "en-GB",
-	DE_DE: "de-DE"
-};
-/**
-* Zod schema for {@link UserLocale}.
-*
-* @group Schemas
-*
-* @example
-* ```ts
-* import { zUserLocale } from '@kyco-utils/enums'
-*
-* zUserLocale.parse('en-GB') // 'en-GB'
-* zUserLocale.safeParse('fr-FR').success // false
-* ```
-*/
-const zUserLocale = zod.enum(UserLocale);
-exports.ColorMode = ColorMode;
-exports.UserLocale = UserLocale;
-exports.zColorMode = zColorMode;
-exports.zUserLocale = zUserLocale;
-
-//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.cjs","names":["z"],"sources":["../src/index.ts"],"sourcesContent":["import * as z from 'zod'\n\n// -------------------------------------------------------\n\n/**\n * Supported color modes available.\n *\n * @enum\n * @example\n * ```ts\n * import { ColorMode } from '@kyco-utils/enums'\n *\n * const mode: ColorMode = ColorMode.DARK // 'dark'\n * ```\n */\nexport const ColorMode = {\n  SYSTEM: 'system',\n  LIGHT: 'light',\n  DARK: 'dark',\n} as const\n\n/**\n * Zod schema for {@link ColorMode}.\n *\n * @group Schemas\n *\n * @example\n * ```ts\n * import { zColorMode } from '@kyco-utils/enums'\n *\n * zColorMode.parse('dark') // 'dark'\n * zColorMode.safeParse('blue').success // false\n * ```\n */\nexport const zColorMode = z.enum([ColorMode.SYSTEM, ColorMode.LIGHT, ColorMode.DARK] as const)\n\nexport type ColorMode = z.infer<typeof zColorMode>\n\n// -------------------------------------------------------\n\n/**\n * Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,\n * i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.\n *\n * @enum\n * @example\n * ```ts\n * import { UserLocale } from '@kyco-utils/enums'\n *\n * const locale: UserLocale = UserLocale.DE_DE // 'de-DE'\n * ```\n */\nexport const UserLocale = {\n  // @locale-updates\n  EN_GB: 'en-GB',\n  DE_DE: 'de-DE',\n} as const\n\n/**\n * Zod schema for {@link UserLocale}.\n *\n * @group Schemas\n *\n * @example\n * ```ts\n * import { zUserLocale } from '@kyco-utils/enums'\n *\n * zUserLocale.parse('en-GB') // 'en-GB'\n * zUserLocale.safeParse('fr-FR').success // false\n * ```\n */\nexport const zUserLocale = z.enum(UserLocale)\n\nexport type UserLocale = z.infer<typeof zUserLocale>\n\n// -------------------------------------------------------\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAeA,MAAa,YAAY;CACvB,QAAQ;CACR,OAAO;CACP,MAAM;AACR;;;;;;;;;;;;;;AAeA,MAAa,aAAaA,IAAE,KAAK;CAAC,UAAU;CAAQ,UAAU;CAAO,UAAU;AAAI,CAAU;;;;;;;;;;;;;AAkB7F,MAAa,aAAa;CAExB,OAAO;CACP,OAAO;AACT;;;;;;;;;;;;;;AAeA,MAAa,cAAcA,IAAE,KAAK,UAAU"}

package/dist/index.d.cts

@@ -1,71 +0,0 @@
-import * as z from "zod";
-/**
- * Supported color modes available.
- *
- * @enum
- * @example
- * ```ts
- * import { ColorMode } from '@kyco-utils/enums'
- *
- * const mode: ColorMode = ColorMode.DARK // 'dark'
- * ```
- */
-export declare const ColorMode: {
-  readonly SYSTEM: 'system';
-  readonly LIGHT: 'light';
-  readonly DARK: 'dark';
-};
-/**
- * Zod schema for {@link ColorMode}.
- *
- * @group Schemas
- *
- * @example
- * ```ts
- * import { zColorMode } from '@kyco-utils/enums'
- *
- * zColorMode.parse('dark') // 'dark'
- * zColorMode.safeParse('blue').success // false
- * ```
- */
-export declare const zColorMode: z.ZodEnum<{
-  dark: "dark";
-  light: "light";
-  system: "system";
-}>;
-export type ColorMode = z.infer<typeof zColorMode>;
-/**
- * Supported locales available. Follows [BCP 47](https://developer.mozilla.org/en-US/docs/Glossary/BCP_47_language_tag) language tags,
- * i.e. generally in the format of `{ISO 639-1}-{ISO 3166-1}`.
- *
- * @enum
- * @example
- * ```ts
- * import { UserLocale } from '@kyco-utils/enums'
- *
- * const locale: UserLocale = UserLocale.DE_DE // 'de-DE'
- * ```
- */
-export declare const UserLocale: {
-  readonly EN_GB: 'en-GB';
-  readonly DE_DE: 'de-DE';
-};
-/**
- * Zod schema for {@link UserLocale}.
- *
- * @group Schemas
- *
- * @example
- * ```ts
- * import { zUserLocale } from '@kyco-utils/enums'
- *
- * zUserLocale.parse('en-GB') // 'en-GB'
- * zUserLocale.safeParse('fr-FR').success // false
- * ```
- */
-export declare const zUserLocale: z.ZodEnum<{
-  readonly EN_GB: 'en-GB';
-  readonly DE_DE: 'de-DE';
-}>;
-export type UserLocale = z.infer<typeof zUserLocale>;
-//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;;qBAea;WACX;WACA;WACA;;;;;;;;;;;;;;;qBAgBW,YAAU,EAAA;;;;;YAEX,YAAY,EAAE,aAAa;;;;;;;;;;;;;qBAgB1B;WAEX;WACA;;;;;;;;;;;;;;;qBAgBW,aAAW,EAAA;WAjBf;WACA;;YAkBG,aAAa,EAAE,aAAa"}

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;;qBAea;WACX;WACA;WACA;;;;;;;;;;;;;;;qBAgBW,YAAU,EAAA;;;;;YAEX,YAAY,EAAE,aAAa;;;;;;;;;;;;;qBAgB1B;WAEX;WACA;;;;;;;;;;;;;;;qBAgBW,aAAW,EAAA;WAjBf;WACA;;YAkBG,aAAa,EAAE,aAAa"}