@xylabs/enum 4.13.14 → 4.13.16

package/README.md

@@ -1,63 +1,54 @@
-[![logo][]](https://xylabs.com)
+# @xylabs/enum
 
-# @xylabs/object
+[![logo][]](https://xylabs.com)
 
+[![main-build][]][main-build-link]
 [![npm-badge][]][npm-link]
 [![npm-downloads-badge][]][npm-link]
 [![jsdelivr-badge][]][jsdelivr-link]
 [![npm-license-badge][]](LICENSE)
+[![codacy-badge][]][codacy-link]
+[![codeclimate-badge][]][codeclimate-link]
+[![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-> XY Labs generalized Javascript library 
-
-## Table of Contents
-
--   [Description](#description)
--   [Install](#install)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
-
-Common Javascript code that is used throughout XYO projects that use React.
+Version: 4.13.15
 
-## Install
+Primary SDK for using XYO Protocol 2.0
 
-Using npm:
-
-```sh
-npm i --save @xylabs/object
-```
-
-Using yarn:
+## Documentation
 
-```sh
-yarn add @xylabs/object
-```
+Coming Soon!
 
-## Documentation
-[Developer Reference](https://xylabs.github.io/sdk-js)
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
 -   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Joel Carter](https://github.com/JoelBCarter)
 -   [Matt Jones](https://github.com/jonesmac)
+-   [Joel Carter](https://github.com/JoelBCarter)
 -   [Jordan Trouw](https://github.com/jordantrouw)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-[Made with 🔥and ❄️ by XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
+[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
+[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/enum.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/enum
+[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
+[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
+[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
+[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
+[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
+[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
 
 [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/enum
 [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/enum

package/dist/neutral/Enum.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Transforms a given record object into a readonly "enum-like" structure while preserving
+ * the literal types of its values. This allows you to use the returned object both at runtime
+ * (for lookups) and at compile time (for strongly typed values).
+ *
+ * To maintain literal types (i.e., prevent them from being widened to `string`, `number`, etc.),
+ * ensure you annotate your object with `as const` before passing it to `Enum`.
+ *
+ * @template T - A record type with string keys and any kind of values.
+ * @param obj - A readonly record object annotated with `as const`.
+ * @returns A readonly version of the provided record, preserving exact literal value types.
+ *
+ * @example
+ * ```typescript
+ * // Defining a record with literal types using as const:
+ * const DnsRecordType = Enum({
+ *   A: 1,
+ *   AAAA: 28,
+ *   CAA: 257,
+ *   CNAME: 5,
+ *   DNAME: 39,
+ *   MX: 15,
+ *   NS: 2,
+ *   PTR: 12,
+ *   SOA: 6,
+ *   SPF: 99,
+ *   SRV: 33,
+ *   TXT: 16,
+ * } as const);
+ *
+ * // DnsRecordType is now a readonly object:
+ * // {
+ * //   readonly A: 1;
+ * //   readonly AAAA: 28;
+ * //   readonly CAA: 257;
+ * //   readonly CNAME: 5;
+ * //   readonly DNAME: 39;
+ * //   readonly MX: 15;
+ * //   readonly NS: 2;
+ * //   readonly PTR: 12;
+ * //   readonly SOA: 6;
+ * //   readonly SPF: 99;
+ * //   readonly SRV: 33;
+ * //   readonly TXT: 16;
+ * // }
+ * ```
+ */
+export declare const Enum: <const T extends Record<string | number | symbol, unknown>>(obj: Readonly<T>) => Enum<T>;
+/**
+ * A utility type that, given a `Record<string, unknown>`, returns a readonly version
+ * of that record. This results in a type where all properties of `T` are readonly.
+ *
+ * @template T - The record type to make readonly.
+ *
+ * @example
+ * ```typescript
+ * // Given a record:
+ * export const DnsRecordType = Enum({
+ *   A: 1,
+ *   AAAA: 28,
+ *   CAA: 257,
+ *   CNAME: 5,
+ *   DNAME: 39,
+ *   MX: 15,
+ *   NS: 2,
+ *   PTR: 12,
+ *   SOA: 6,
+ *   SPF: 99,
+ *   SRV: 33,
+ *   TXT: 16,
+ * })
+ *
+ * // Now the type inference will preserve the literal types:
+ * export type DnsRecordType = Enum<typeof DnsRecordType>
+ * ```
+ */
+export type Enum<T extends Readonly<Record<string | number | symbol, unknown>>> = {
+    readonly [K in keyof T]: T[K];
+};
+/**
+ * A utility type that, given an `Enum` object, returns the union of its keys.
+ */
+export type EnumKey<T extends Record<string | number | symbol, unknown>, K = Enum<T>> = keyof K;
+/**
+ * A utility type that, given an `Enum` object, returns the union of its values.
+ */
+export type EnumValue<T extends Record<string | number | symbol, unknown>, K = Enum<T>> = K[keyof K];
+//# sourceMappingURL=Enum.d.ts.map

package/dist/neutral/Enum.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Enum.d.ts","sourceRoot":"","sources":["../../src/Enum.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,eAAO,MAAM,IAAI,GAAI,KAAK,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAG,IAAI,CAAC,CAAC,CAExG,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI;IAChF,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAA;AAE/F;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA"}

package/dist/neutral/index.d.ts

@@ -1,90 +1,2 @@
-/**
- * Transforms a given record object into a readonly "enum-like" structure while preserving
- * the literal types of its values. This allows you to use the returned object both at runtime
- * (for lookups) and at compile time (for strongly typed values).
- *
- * To maintain literal types (i.e., prevent them from being widened to `string`, `number`, etc.),
- * ensure you annotate your object with `as const` before passing it to `Enum`.
- *
- * @template T - A record type with string keys and any kind of values.
- * @param obj - A readonly record object annotated with `as const`.
- * @returns A readonly version of the provided record, preserving exact literal value types.
- *
- * @example
- * ```typescript
- * // Defining a record with literal types using as const:
- * const DnsRecordType = Enum({
- *   A: 1,
- *   AAAA: 28,
- *   CAA: 257,
- *   CNAME: 5,
- *   DNAME: 39,
- *   MX: 15,
- *   NS: 2,
- *   PTR: 12,
- *   SOA: 6,
- *   SPF: 99,
- *   SRV: 33,
- *   TXT: 16,
- * } as const);
- *
- * // DnsRecordType is now a readonly object:
- * // {
- * //   readonly A: 1;
- * //   readonly AAAA: 28;
- * //   readonly CAA: 257;
- * //   readonly CNAME: 5;
- * //   readonly DNAME: 39;
- * //   readonly MX: 15;
- * //   readonly NS: 2;
- * //   readonly PTR: 12;
- * //   readonly SOA: 6;
- * //   readonly SPF: 99;
- * //   readonly SRV: 33;
- * //   readonly TXT: 16;
- * // }
- * ```
- */
-declare const Enum: <const T extends Record<string | number | symbol, unknown>>(obj: Readonly<T>) => Enum<T>;
-/**
- * A utility type that, given a `Record<string, unknown>`, returns a readonly version
- * of that record. This results in a type where all properties of `T` are readonly.
- *
- * @template T - The record type to make readonly.
- *
- * @example
- * ```typescript
- * // Given a record:
- * export const DnsRecordType = Enum({
- *   A: 1,
- *   AAAA: 28,
- *   CAA: 257,
- *   CNAME: 5,
- *   DNAME: 39,
- *   MX: 15,
- *   NS: 2,
- *   PTR: 12,
- *   SOA: 6,
- *   SPF: 99,
- *   SRV: 33,
- *   TXT: 16,
- * })
- *
- * // Now the type inference will preserve the literal types:
- * export type DnsRecordType = Enum<typeof DnsRecordType>
- * ```
- */
-type Enum<T extends Readonly<Record<string | number | symbol, unknown>>> = {
-    readonly [K in keyof T]: T[K];
-};
-/**
- * A utility type that, given an `Enum` object, returns the union of its keys.
- */
-type EnumKey<T extends Record<string | number | symbol, unknown>, K = Enum<T>> = keyof K;
-/**
- * A utility type that, given an `Enum` object, returns the union of its values.
- */
-type EnumValue<T extends Record<string | number | symbol, unknown>, K = Enum<T>> = K[keyof K];
-
-export { Enum };
-export type { EnumKey, EnumValue };
+export * from './Enum.ts';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/enum",
-  "version": "4.13.14",
+  "version": "4.13.16",
   "description": "Primary SDK for using XYO Protocol 2.0",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -29,8 +29,8 @@
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.12",
-    "@xylabs/tsconfig": "^7.0.0-rc.12",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig": "^7.0.0-rc.27",
     "typescript": "^5.8.3"
   },
   "publishConfig": {