@xylabs/enum 4.13.19 → 4.13.21

package/README.md

@@ -12,13 +12,192 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.15
 
-Primary SDK for using XYO Protocol 2.0
+Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
-## Documentation
+## API Documentation
+
+**@xylabs/enum**
+
+***
+
+## Type Aliases
+
+- [Enum](#type-aliases/Enum)
+- [EnumKey](#type-aliases/EnumKey)
+- [EnumValue](#type-aliases/EnumValue)
+
+## Functions
+
+- [Enum](#functions/Enum)
+
+### functions
+
+  ### <a id="Enum"></a>Enum
+
+[**@xylabs/enum**](#../README)
+
+***
+
+```ts
+function Enum<T>(obj): Enum<T>;
+```
+
+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`.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
+
+A record type with string keys and any kind of values.
+
+## Parameters
+
+### obj
+
+`Readonly`\<`T`\>
+
+A readonly record object annotated with `as const`.
+
+## Returns
+
+[`Enum`](#../type-aliases/Enum)\<`T`\>
+
+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;
+// }
+```
+
+### type-aliases
+
+  ### <a id="Enum"></a>Enum
+
+[**@xylabs/enum**](#../README)
+
+***
+
+```ts
+type Enum<T> = { readonly [K in keyof T]: T[K] };
+```
+
+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.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Readonly`\<`Record`\<`string` \| `number` \| `symbol`, `unknown`\>\>
+
+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>
+```
+
+  ### <a id="EnumKey"></a>EnumKey
+
+[**@xylabs/enum**](#../README)
+
+***
+
+```ts
+type EnumKey<T, K> = keyof K;
+```
+
+A utility type that, given an `Enum` object, returns the union of its keys.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
+
+### K
+
+`K` = [`Enum`](#Enum)\<`T`\>
+
+  ### <a id="EnumValue"></a>EnumValue
+
+[**@xylabs/enum**](#../README)
+
+***
+
+```ts
+type EnumValue<T, K> = K[keyof K];
+```
+
+A utility type that, given an `Enum` object, returns the union of its values.
+
+## Type Parameters
+
+### T
+
+`T` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
+
+### K
+
+`K` = [`Enum`](#Enum)\<`T`\>
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xylabs/enum",
-  "version": "4.13.19",
-  "description": "Primary SDK for using XYO Protocol 2.0",
+  "version": "4.13.21",
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "homepage": "https://xyo.network",
   "bugs": {
     "url": "git+https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues",
@@ -22,15 +22,21 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
+      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "module": "dist/neutral/index.mjs",
-  "types": "dist/neutral/index.d.ts",
+  "module": "./dist/neutral/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
-    "@xylabs/tsconfig": "^7.0.0-rc.27",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0",
+    "@xylabs/tsconfig": "^7.0.0",
     "typescript": "^5.8.3"
   },
   "publishConfig": {

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    neutral: { src: true },
-    node: {},
-  },
-}
-
-export default config