@digitaldefiance/branded-enum 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * branded-enum - Runtime-identifiable enum-like types for TypeScript
+ *
+ * This library provides enum-like objects with embedded metadata for runtime
+ * identification, enabling you to determine which enum a string value belongs to.
+ *
+ * @packageDocumentation
+ */
+export type { BrandedEnumMetadata, BrandedEnum, BrandedEnumValue, RegistryEntry, BrandedEnumRegistry, EnumConsumerEntry, EnumConsumerRegistry, AnyBrandedEnum, EnumKeys, EnumValues, ValidEnumValue, StrictEnumParam, } from './lib/types.js';
+export { createBrandedEnum } from './lib/factory.js';
+export { getRegistry, getAllEnumIds, getEnumById, findEnumSources, } from './lib/registry.js';
+export { isFromEnum, assertFromEnum, parseEnum, safeParseEnum } from './lib/guards.js';
+export type { SafeParseSuccess, SafeParseFailure, SafeParseError, SafeParseErrorCode, SafeParseResult } from './lib/guards.js';
+export { getEnumId, getEnumValues, enumSize } from './lib/accessors.js';
+export { hasValue, getKeyForValue, isValidKey, enumEntries, } from './lib/utils.js';
+export { mergeEnums } from './lib/merge.js';
+export { enumSubset, enumExclude, enumMap, enumFromKeys, enumDiff, enumIntersect, enumToRecord, watchEnum, watchAllEnums, clearAllEnumWatchers, getEnumWatcherCount, getGlobalWatcherCount, exhaustive, exhaustiveGuard, toJsonSchema, toZodSchema, enumSerializer } from './lib/advanced.js';
+export type { EnumDiffResult, EnumIntersectEntry, EnumAccessType, EnumAccessEvent, EnumWatchCallback, WatchEnumResult, ToJsonSchemaOptions, EnumJsonSchema, ToZodSchemaOptions, ZodEnumSchemaDefinition, EnumSerializerOptions, DeserializeSuccess, DeserializeFailure, DeserializeResult, EnumSerializer } from './lib/advanced.js';
+export { EnumValue, EnumClass, getEnumConsumers, getConsumedEnums, getAllEnumConsumers, } from './lib/decorators.js';
+export type { EnumValueOptions } from './lib/decorators.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,YAAY,EACV,mBAAmB,EACnB,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,cAAc,EACd,QAAQ,EACR,UAAU,EACV,cAAc,EACd,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAMxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAMrD,OAAO,EACL,WAAW,EACX,aAAa,EACb,WAAW,EACX,eAAe,GAChB,MAAM,mBAAmB,CAAC;AAM3B,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACvF,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,cAAc,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAM/H,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAMxE,OAAO,EACL,QAAQ,EACR,cAAc,EACd,UAAU,EACV,WAAW,GACZ,MAAM,gBAAgB,CAAC;AAMxB,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAM5C,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,UAAU,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAC9R,YAAY,EAAE,cAAc,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAE,eAAe,EAAE,mBAAmB,EAAE,cAAc,EAAE,kBAAkB,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAMrU,OAAO,EACL,SAAS,EACT,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/lib/accessors.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Metadata accessors for branded enums.
+ *
+ * Provides functions to retrieve metadata from branded enum objects,
+ * including enum ID, values array, and size.
+ */
+import { AnyBrandedEnum, EnumValues } from './types.js';
+/**
+ * Gets the enum ID from a branded enum.
+ *
+ * Retrieves the unique identifier that was assigned when the enum was created.
+ * Returns undefined for objects that are not branded enums.
+ *
+ * @param enumObj - The object to get the enum ID from. Can be any type.
+ * @returns The enum ID string if enumObj is a branded enum, `undefined` otherwise.
+ *
+ * @example
+ * // Get ID from branded enum
+ * const Status = createBrandedEnum('status', { Active: 'active' } as const);
+ * getEnumId(Status); // 'status'
+ *
+ * @example
+ * // Returns undefined for non-branded objects
+ * getEnumId({}); // undefined
+ * getEnumId({ Active: 'active' }); // undefined
+ * getEnumId(null); // undefined
+ */
+export declare function getEnumId(enumObj: unknown): string | undefined;
+/**
+ * Gets all values from a branded enum as an array.
+ *
+ * Returns an array containing all the string values in the enum.
+ * The order of values is not guaranteed.
+ *
+ * @template E - The branded enum type
+ * @param enumObj - The object to get values from. Can be any type.
+ * @returns Array of all enum values if enumObj is a branded enum,
+ *   `undefined` otherwise.
+ *
+ * @example
+ * // Get values from branded enum
+ * const Status = createBrandedEnum('status', {
+ *   Active: 'active',
+ *   Inactive: 'inactive'
+ * } as const);
+ * getEnumValues(Status); // ['active', 'inactive']
+ *
+ * @example
+ * // Returns undefined for non-branded objects
+ * getEnumValues({}); // undefined
+ * getEnumValues({ Active: 'active' }); // undefined
+ */
+export declare function getEnumValues<E extends AnyBrandedEnum>(enumObj: E): EnumValues<E>[] | undefined;
+export declare function getEnumValues(enumObj: unknown): string[] | undefined;
+/**
+ * Gets the number of values in a branded enum.
+ *
+ * Returns the count of unique values in the enum. This is equivalent to
+ * the number of key-value pairs defined when the enum was created.
+ *
+ * @param enumObj - The object to get the size of. Can be any type.
+ * @returns The number of values in the enum if enumObj is a branded enum,
+ *   `undefined` otherwise.
+ *
+ * @example
+ * // Get size of branded enum
+ * const Status = createBrandedEnum('status', {
+ *   Active: 'active',
+ *   Inactive: 'inactive'
+ * } as const);
+ * enumSize(Status); // 2
+ *
+ * @example
+ * // Returns undefined for non-branded objects
+ * enumSize({}); // undefined
+ * enumSize({ Active: 'active' }); // undefined
+ */
+export declare function enumSize(enumObj: unknown): number | undefined;
+//# sourceMappingURL=accessors.d.ts.map

package/dist/lib/accessors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accessors.d.ts","sourceRoot":"","sources":["../../src/lib/accessors.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,cAAc,EAKd,UAAU,EACX,MAAM,YAAY,CAAC;AAmBpB;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAK9D;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,cAAc,EACpD,OAAO,EAAE,CAAC,GACT,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC;AAC/B,wBAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC;AAQtE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAK7D"}