@xivdyetools/types 1.7.0 → 1.9.0

package/dist/preset/response.d.ts

@@ -24,6 +24,7 @@ export interface PresetListResponse {
 }
 /**
  * Successful preset creation response
+ * @internal Not for direct consumer import — use `PresetSubmitResponse` union instead
  */
 export interface PresetSubmitCreatedResponse {
     /** Operation succeeded */
@@ -35,6 +36,7 @@ export interface PresetSubmitCreatedResponse {
 }
 /**
  * Duplicate preset found response
+ * @internal Not for direct consumer import — use `PresetSubmitResponse` union instead
  */
 export interface PresetSubmitDuplicateResponse {
     /** Operation succeeded (duplicate handling is not an error) */
@@ -46,6 +48,7 @@ export interface PresetSubmitDuplicateResponse {
 }
 /**
  * Failed preset submission response
+ * @internal Not for direct consumer import — use `PresetSubmitResponse` union instead
  */
 export interface PresetSubmitErrorResponse {
     /** Operation failed */
@@ -64,6 +67,7 @@ export interface PresetSubmitErrorResponse {
 export type PresetSubmitResponse = PresetSubmitCreatedResponse | PresetSubmitDuplicateResponse | PresetSubmitErrorResponse;
 /**
  * Duplicate preset info for edit conflict
+ * @internal Not for direct consumer import — use `PresetEditResponse` union instead
  */
 export interface PresetEditDuplicateInfo {
     id: string;
@@ -72,6 +76,7 @@ export interface PresetEditDuplicateInfo {
 }
 /**
  * Successful preset edit response
+ * @internal Not for direct consumer import — use `PresetEditResponse` union instead
  */
 export interface PresetEditSuccessResponse {
     /** Operation succeeded */
@@ -83,6 +88,7 @@ export interface PresetEditSuccessResponse {
 }
 /**
  * Preset edit blocked due to duplicate
+ * @internal Not for direct consumer import — use `PresetEditResponse` union instead
  */
 export interface PresetEditDuplicateResponse {
     /** Operation failed due to duplicate */
@@ -94,6 +100,7 @@ export interface PresetEditDuplicateResponse {
 }
 /**
  * Failed preset edit response
+ * @internal Not for direct consumer import — use `PresetEditResponse` union instead
  */
 export interface PresetEditErrorResponse {
     /** Operation failed */
@@ -109,6 +116,7 @@ export interface PresetEditErrorResponse {
 export type PresetEditResponse = PresetEditSuccessResponse | PresetEditDuplicateResponse | PresetEditErrorResponse;
 /**
  * Successful vote response
+ * @internal Not for direct consumer import — use `VoteResponse` union instead
  */
 export interface VoteSuccessResponse {
     /** Operation succeeded */
@@ -120,6 +128,7 @@ export interface VoteSuccessResponse {
 }
 /**
  * Failed vote response
+ * @internal Not for direct consumer import — use `VoteResponse` union instead
  */
 export interface VoteErrorResponse {
     /** Operation failed */
@@ -135,6 +144,7 @@ export interface VoteErrorResponse {
 export type VoteResponse = VoteSuccessResponse | VoteErrorResponse;
 /**
  * Successful moderation response
+ * @internal Not for direct consumer import — use `ModerationResponse` union instead
  */
 export interface ModerationSuccessResponse {
     /** Operation succeeded */
@@ -144,6 +154,7 @@ export interface ModerationSuccessResponse {
 }
 /**
  * Failed moderation response
+ * @internal Not for direct consumer import — use `ModerationResponse` union instead
  */
 export interface ModerationErrorResponse {
     /** Operation failed */

package/dist/preset/response.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/preset/response.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uBAAuB;IACvB,OAAO,EAAE,eAAe,EAAE,CAAC;IAE3B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IAEd,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,+BAA+B;IAC/B,MAAM,EAAE,eAAe,CAAC;IAExB,wBAAwB;IACxB,iBAAiB,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C,+DAA+D;IAC/D,OAAO,EAAE,IAAI,CAAC;IAEd,uCAAuC;IACvC,SAAS,EAAE,eAAe,CAAC;IAE3B,gDAAgD;IAChD,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,6BAA6B,GAC7B,yBAAyB,CAAC;AAE9B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,MAAM,EAAE,eAAe,CAAC;IAExB,mDAAmD;IACnD,iBAAiB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,wCAAwC;IACxC,OAAO,EAAE,KAAK,CAAC;IAEf,wCAAwC;IACxC,SAAS,EAAE,uBAAuB,CAAC;IAEnC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,yBAAyB,GACzB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,cAAc,EAAE,MAAM,CAAC;IAEvB,sDAAsD;IACtD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,MAAM,EAAE,eAAe,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,UAAU,EAAE,YAAY,EAAE,CAAC;CAC5B"}
+{"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../src/preset/response.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uBAAuB;IACvB,OAAO,EAAE,eAAe,EAAE,CAAC;IAE3B,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;IAEd,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IAEd,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,+BAA+B;IAC/B,MAAM,EAAE,eAAe,CAAC;IAExB,wBAAwB;IACxB,iBAAiB,EAAE,UAAU,GAAG,SAAS,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,+DAA+D;IAC/D,OAAO,EAAE,IAAI,CAAC;IAEd,uCAAuC;IACvC,SAAS,EAAE,eAAe,CAAC;IAE3B,gDAAgD;IAChD,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,6BAA6B,GAC7B,yBAAyB,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,MAAM,EAAE,eAAe,CAAC;IAExB,mDAAmD;IACnD,iBAAiB,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAC5C;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,wCAAwC;IACxC,OAAO,EAAE,KAAK,CAAC;IAEf,wCAAwC;IACxC,SAAS,EAAE,uBAAuB,CAAC;IAEnC,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,yBAAyB,GACzB,2BAA2B,GAC3B,uBAAuB,CAAC;AAE5B;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,cAAc,EAAE,MAAM,CAAC;IAEvB,sDAAsD;IACtD,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEnE;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,yBAAyB;IACzB,MAAM,EAAE,eAAe,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,uBAAuB;IACvB,OAAO,EAAE,KAAK,CAAC;IAEf,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,yBAAyB,GAAG,uBAAuB,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,iCAAiC;IACjC,UAAU,EAAE,YAAY,EAAE,CAAC;CAC5B"}

package/package.json

@@ -1,82 +1,81 @@
-{
-  "name": "@xivdyetools/types",
-  "version": "1.7.0",
-  "description": "Shared TypeScript type definitions for the xivdyetools ecosystem",
-  "author": "XIV Dye Tools",
-  "license": "MIT",
-  "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./color": {
-      "types": "./dist/color/index.d.ts",
-      "import": "./dist/color/index.js"
-    },
-    "./dye": {
-      "types": "./dist/dye/index.d.ts",
-      "import": "./dist/dye/index.js"
-    },
-    "./character": {
-      "types": "./dist/character/index.d.ts",
-      "import": "./dist/character/index.js"
-    },
-    "./preset": {
-      "types": "./dist/preset/index.d.ts",
-      "import": "./dist/preset/index.js"
-    },
-    "./auth": {
-      "types": "./dist/auth/index.d.ts",
-      "import": "./dist/auth/index.js"
-    },
-    "./api": {
-      "types": "./dist/api/index.d.ts",
-      "import": "./dist/api/index.js"
-    },
-    "./error": {
-      "types": "./dist/error/index.d.ts",
-      "import": "./dist/error/index.js"
-    },
-    "./localization": {
-      "types": "./dist/localization/index.d.ts",
-      "import": "./dist/localization/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "sideEffects": false,
-  "scripts": {
-    "build": "tsc -p tsconfig.build.json",
-    "type-check": "tsc --noEmit",
-    "clean": "rimraf dist",
-    "prepublishOnly": "npm run clean && npm run build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "test:coverage": "vitest run --coverage"
-  },
-  "devDependencies": {
-    "@vitest/coverage-v8": "^4.0.15",
-    "rimraf": "^5.0.5",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.15"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "keywords": [
-    "xivdyetools",
-    "ffxiv",
-    "dyes",
-    "typescript",
-    "types"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/xivdyetools/xivdyetools-types.git"
-  }
+{
+  "name": "@xivdyetools/types",
+  "version": "1.9.0",
+  "description": "Shared TypeScript type definitions for the xivdyetools ecosystem",
+  "author": "XIV Dye Tools",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./color": {
+      "types": "./dist/color/index.d.ts",
+      "import": "./dist/color/index.js"
+    },
+    "./dye": {
+      "types": "./dist/dye/index.d.ts",
+      "import": "./dist/dye/index.js"
+    },
+    "./character": {
+      "types": "./dist/character/index.d.ts",
+      "import": "./dist/character/index.js"
+    },
+    "./preset": {
+      "types": "./dist/preset/index.d.ts",
+      "import": "./dist/preset/index.js"
+    },
+    "./auth": {
+      "types": "./dist/auth/index.d.ts",
+      "import": "./dist/auth/index.js"
+    },
+    "./api": {
+      "types": "./dist/api/index.d.ts",
+      "import": "./dist/api/index.js"
+    },
+    "./error": {
+      "types": "./dist/error/index.d.ts",
+      "import": "./dist/error/index.js"
+    },
+    "./localization": {
+      "types": "./dist/localization/index.d.ts",
+      "import": "./dist/localization/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "@vitest/coverage-v8": "^4.0.18",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "xivdyetools",
+    "ffxiv",
+    "dyes",
+    "typescript",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/FlashGalatine/xivdyetools.git",
+    "directory": "packages/types"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "type-check": "tsc --noEmit",
+    "clean": "rimraf dist",
+    "lint": "eslint src",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
 }

package/dist/utility/index.d.ts

@@ -1,71 +0,0 @@
-/**
- * @xivdyetools/types - Utility Types
- *
- * Generic utility types for common patterns.
- *
- * @module utility
- */
-import type { AppError } from '../error/app-error.js';
-/**
- * Generic result type for operations that might fail
- *
- * Use this for functions that can return either a value or an error,
- * avoiding exceptions for expected failure cases.
- *
- * @example
- * ```typescript
- * function parseColor(hex: string): Result<RGB> {
- *   if (!isValidHex(hex)) {
- *     return { ok: false, error: new AppError('INVALID_HEX', 'Invalid hex color') };
- *   }
- *   return { ok: true, value: hexToRgb(hex) };
- * }
- *
- * const result = parseColor('#ff0000');
- * if (result.ok) {
- *   console.log(result.value); // RGB object
- * } else {
- *   console.error(result.error.message);
- * }
- * ```
- */
-export type Result<T, E = AppError> = {
-    ok: true;
-    value: T;
-} | {
-    ok: false;
-    error: E;
-};
-/**
- * Async result type
- *
- * Promise wrapper around Result for async operations.
- */
-export type AsyncResult<T, E = AppError> = Promise<Result<T, E>>;
-/**
- * Nullable type
- *
- * Value that can be T or null.
- */
-export type Nullable<T> = T | null;
-/**
- * Optional type
- *
- * Value that can be T or undefined.
- */
-export type Optional<T> = T | undefined;
-/**
- * Type guard for checking if a Result is successful
- */
-export declare function isOk<T, E>(result: Result<T, E>): result is {
-    ok: true;
-    value: T;
-};
-/**
- * Type guard for checking if a Result is an error
- */
-export declare function isErr<T, E>(result: Result<T, E>): result is {
-    ok: false;
-    error: E;
-};
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utility/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,IAC9B;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GACtB;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAAC;AAE5B;;;;GAIG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAEnC;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;AAExC;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAEjF;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,CAEnF"}

package/dist/utility/index.js

@@ -1,20 +0,0 @@
-/**
- * @xivdyetools/types - Utility Types
- *
- * Generic utility types for common patterns.
- *
- * @module utility
- */
-/**
- * Type guard for checking if a Result is successful
- */
-export function isOk(result) {
-    return result.ok;
-}
-/**
- * Type guard for checking if a Result is an error
- */
-export function isErr(result) {
-    return !result.ok;
-}
-//# sourceMappingURL=index.js.map

package/dist/utility/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utility/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAoDH;;GAEG;AACH,MAAM,UAAU,IAAI,CAAO,MAAoB;IAC7C,OAAO,MAAM,CAAC,EAAE,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAO,MAAoB;IAC9C,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACpB,CAAC"}