@kyco-utils/enums 0.1.2 → 0.1.3

package/dist/index.cjs

@@ -25,12 +25,33 @@ 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,
@@ -39,11 +60,32 @@ const zColorMode = zod.enum([
 /**
 * 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;

package/dist/index.cjs.map

@@ -1 +1 @@
-{"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 */\nexport const ColorMode = {\n  SYSTEM: 'system',\n  LIGHT: 'light',\n  DARK: 'dark',\n} as const\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 */\nexport const UserLocale = {\n  // @locale-updates\n  EN_GB: 'en-GB',\n  DE_DE: 'de-DE',\n} as const\n\nexport const zUserLocale = z.enum(UserLocale)\n\nexport type UserLocale = z.infer<typeof zUserLocale>\n\n// -------------------------------------------------------\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,MAAa,YAAY;CACvB,QAAQ;CACR,OAAO;CACP,MAAM;AACR;AAEA,MAAa,aAAaA,IAAE,KAAK;CAAC,UAAU;CAAQ,UAAU;CAAO,UAAU;AAAI,CAAU;;;;;AAU7F,MAAa,aAAa;CAExB,OAAO;CACP,OAAO;AACT;AAEA,MAAa,cAAcA,IAAE,KAAK,UAAU"}
+{"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,12 +1,33 @@
 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";
@@ -16,11 +37,32 @@ 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';

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;;;qBAOa;WACX;WACA;WACA;;qBAGW,YAAU,EAAA;;;;;YAEX,YAAY,EAAE,aAAa;;;;;qBAQ1B;WAEX;WACA;;qBAGW,aAAW,EAAA;WAJf;WACA;;YAKG,aAAa,EAAE,aAAa"}
+{"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

@@ -1,12 +1,33 @@
 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";
@@ -16,11 +37,32 @@ 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';

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;qBAOa;WACX;WACA;WACA;;qBAGW,YAAU,EAAA;;;;;YAEX,YAAY,EAAE,aAAa;;;;;qBAQ1B;WAEX;WACA;;qBAGW,aAAW,EAAA;WAJf;WACA;;YAKG,aAAa,EAAE,aAAa"}
+{"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"}

package/dist/index.mjs

@@ -2,12 +2,33 @@ import * as z from "zod";
 // 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 = z.enum([
 	ColorMode.SYSTEM,
 	ColorMode.LIGHT,
@@ -16,11 +37,32 @@ const zColorMode = z.enum([
 /**
 * 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 = z.enum(UserLocale);
 export { ColorMode, UserLocale, zColorMode, zUserLocale };
 

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 */\nexport const ColorMode = {\n  SYSTEM: 'system',\n  LIGHT: 'light',\n  DARK: 'dark',\n} as const\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 */\nexport const UserLocale = {\n  // @locale-updates\n  EN_GB: 'en-GB',\n  DE_DE: 'de-DE',\n} as const\n\nexport const zUserLocale = z.enum(UserLocale)\n\nexport type UserLocale = z.infer<typeof zUserLocale>\n\n// -------------------------------------------------------\n"],"mappings":";;;;;AAOA,MAAa,YAAY;CACvB,QAAQ;CACR,OAAO;CACP,MAAM;AACR;AAEA,MAAa,aAAa,EAAE,KAAK;CAAC,UAAU;CAAQ,UAAU;CAAO,UAAU;AAAI,CAAU;;;;;AAU7F,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 * 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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kyco-utils/enums",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Shared runtime enums and Zod schemas for kyco-utils.",
   "type": "module",
   "sideEffects": false,