@outfitter/types 0.1.0-rc.1

package/dist/utilities.d.ts

@@ -0,0 +1,99 @@
+/**
+* General type utilities for TypeScript.
+*
+* @module utilities
+*/
+/**
+* Makes specific properties of a type required.
+*
+* @example
+* ```typescript
+* interface Config { host?: string; port?: number; }
+* type RequiredHost = RequiredKeys<Config, "host">;
+* // { host: string; port?: number; }
+* ```
+*/
+type RequiredKeys<
+	T,
+	K extends keyof T
+> = T & Required<Pick<T, K>>;
+/**
+* Makes specific properties of a type optional.
+*
+* @example
+* ```typescript
+* interface User { id: string; name: string; email: string; }
+* type PartialUser = OptionalKeys<User, "email">;
+* // { id: string; name: string; email?: string; }
+* ```
+*/
+type OptionalKeys<
+	T,
+	K extends keyof T
+> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+* Deeply makes all properties readonly.
+*/
+type DeepReadonly<T> = { readonly [P in keyof T] : T[P] extends object ? DeepReadonly<T[P]> : T[P] };
+/**
+* Deeply makes all properties partial (optional).
+*/
+type DeepPartial<T> = { [P in keyof T]? : T[P] extends object ? DeepPartial<T[P]> : T[P] };
+/**
+* Creates a type that requires at least one of the specified keys.
+*
+* @example
+* ```typescript
+* type Props = AtLeastOne<{ a?: string; b?: number; c?: boolean }, "a" | "b">;
+* // Must have at least 'a' or 'b'
+* ```
+*/
+type AtLeastOne<
+	T,
+	Keys extends keyof T = keyof T
+> = Omit<T, Keys> & { [K in Keys]-? : Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>> }[Keys];
+/**
+* Creates a type that requires exactly one of the specified keys.
+*
+* @example
+* ```typescript
+* type Auth = ExactlyOne<{ token?: string; apiKey?: string }, "token" | "apiKey">;
+* // Must have exactly one of 'token' or 'apiKey', not both
+* ```
+*/
+type ExactlyOne<
+	T,
+	Keys extends keyof T = keyof T
+> = Omit<T, Keys> & { [K in Keys]-? : Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, never>> }[Keys];
+/**
+* Extracts the element type from an array type.
+*/
+type ElementOf<T> = T extends readonly (infer E)[] ? E : never;
+/**
+* Creates a union type from object values.
+*/
+type ValueOf<T> = T[keyof T];
+/**
+* Makes a type's properties mutable (removes readonly).
+*/
+type Mutable<T> = { -readonly [P in keyof T] : T[P] };
+/**
+* Asserts at compile time that a type is never (exhaustiveness check).
+*
+* @param value - The value that should be never
+* @throws Error - Always throws if reached at runtime
+*
+* @example
+* ```typescript
+* type Status = "pending" | "done";
+* function handle(status: Status) {
+*   switch (status) {
+*     case "pending": return "...";
+*     case "done": return "ok";
+*     default: return assertNever(status);
+*   }
+* }
+* ```
+*/
+declare function assertNever(value: never): never;
+export { assertNever, ValueOf, RequiredKeys, OptionalKeys, Mutable, ExactlyOne, ElementOf, DeepReadonly, DeepPartial, AtLeastOne };

package/dist/utilities.js

@@ -0,0 +1,8 @@
+// @bun
+// packages/types/src/utilities.ts
+function assertNever(value) {
+  throw new Error(`Unexpected value: ${JSON.stringify(value)}`);
+}
+export {
+  assertNever
+};

package/package.json

@@ -0,0 +1,92 @@
+{
+  "name": "@outfitter/types",
+  "description": "Branded types, type guards, and type utilities for Outfitter",
+  "version": "0.1.0-rc.1",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./deep": {
+      "import": {
+        "types": "./dist/deep.d.ts",
+        "default": "./dist/deep.js"
+      }
+    },
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./utilities": {
+      "import": {
+        "types": "./dist/utilities.d.ts",
+        "default": "./dist/utilities.js"
+      }
+    },
+    "./collections": {
+      "import": {
+        "types": "./dist/collections.d.ts",
+        "default": "./dist/collections.js"
+      }
+    },
+    "./short-id": {
+      "import": {
+        "types": "./dist/short-id.d.ts",
+        "default": "./dist/short-id.js"
+      }
+    },
+    "./hash-id": {
+      "import": {
+        "types": "./dist/hash-id.d.ts",
+        "default": "./dist/hash-id.js"
+      }
+    },
+    "./branded": {
+      "import": {
+        "types": "./dist/branded.d.ts",
+        "default": "./dist/branded.js"
+      }
+    },
+    "./guards": {
+      "import": {
+        "types": "./dist/guards.d.ts",
+        "default": "./dist/guards.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "bunup --filter @outfitter/types",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@outfitter/contracts": "workspace:*",
+    "better-result": "^2.5.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5.8.0"
+  },
+  "keywords": [
+    "outfitter",
+    "types",
+    "branded",
+    "typescript"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/outfitter-dev/outfitter.git",
+    "directory": "packages/types"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}