@shipstatic/types 0.4.12 → 0.4.14

package/dist/index.d.ts

@@ -292,11 +292,10 @@ export declare class ShipError extends Error {
     static cancelled(message: string): ShipError;
     static file(message: string, filePath?: string): ShipError;
     static config(message: string, details?: any): ShipError;
-    static api(message: string, status?: number, code?: string, data?: any): ShipError;
+    static api(message: string, status?: number): ShipError;
     static database(message: string, status?: number): ShipError;
     static storage(message: string, status?: number): ShipError;
     get filePath(): string | undefined;
-    get code(): string | undefined;
     isClientError(): boolean;
     isNetworkError(): boolean;
     isAuthError(): boolean;
@@ -305,6 +304,18 @@ export declare class ShipError extends Error {
     isConfigError(): boolean;
     isType(errorType: ErrorType): boolean;
 }
+/**
+ * Type guard to check if an unknown value is a ShipError.
+ *
+ * Uses structural checking instead of instanceof to handle module duplication
+ * in bundled applications where multiple copies of the ShipError class may exist.
+ *
+ * @example
+ * if (isShipError(error)) {
+ *   console.log(error.status, error.message);
+ * }
+ */
+export declare function isShipError(error: unknown): error is ShipError;
 /**
  * Platform configuration response from API
  */
@@ -501,6 +512,11 @@ export interface DomainResource {
     verify: (name: string) => Promise<{
         message: string;
     }>;
+    validate: (name: string) => Promise<{
+        valid: boolean;
+        normalized?: string;
+        error?: string;
+    }>;
     dns: (name: string) => Promise<DomainDnsResponse>;
     records: (name: string) => Promise<DomainRecordsResponse>;
     share: (name: string) => Promise<{

package/dist/index.js

@@ -138,8 +138,8 @@ export class ShipError extends Error {
     static config(message, details) {
         return new ShipError(ErrorType.Config, message, undefined, details);
     }
-    static api(message, status = 500, code, data) {
-        return new ShipError(ErrorType.Api, message, status, { code, data });
+    static api(message, status = 500) {
+        return new ShipError(ErrorType.Api, message, status);
     }
     static database(message, status = 500) {
         return new ShipError(ErrorType.Api, message, status);
@@ -147,13 +147,10 @@ export class ShipError extends Error {
     static storage(message, status = 500) {
         return new ShipError(ErrorType.Api, message, status);
     }
-    // Helper getters for accessing common detail properties
+    // Helper getter for accessing file path from details
     get filePath() {
         return this.details?.filePath;
     }
-    get code() {
-        return this.details?.code;
-    }
     // Helper methods for error type checking using categorization
     isClientError() {
         return ERROR_CATEGORIES.client.has(this.type);
@@ -178,6 +175,24 @@ export class ShipError extends Error {
         return this.type === errorType;
     }
 }
+/**
+ * Type guard to check if an unknown value is a ShipError.
+ *
+ * Uses structural checking instead of instanceof to handle module duplication
+ * in bundled applications where multiple copies of the ShipError class may exist.
+ *
+ * @example
+ * if (isShipError(error)) {
+ *   console.log(error.status, error.message);
+ * }
+ */
+export function isShipError(error) {
+    return (error !== null &&
+        typeof error === 'object' &&
+        'name' in error &&
+        error.name === 'ShipError' &&
+        'status' in error);
+}
 // API Key Configuration
 export const API_KEY_PREFIX = 'ship-';
 export const API_KEY_HEX_LENGTH = 64;
@@ -246,7 +261,7 @@ export function validateApiUrl(apiUrl) {
         }
     }
     catch (error) {
-        if (error instanceof ShipError) {
+        if (isShipError(error)) {
             throw error;
         }
         throw ShipError.validation('API URL must be a valid URL');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipstatic/types",
-  "version": "0.4.12",
+  "version": "0.4.14",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -395,8 +395,8 @@ export class ShipError extends Error {
     return new ShipError(ErrorType.Config, message, undefined, details);
   }
 
-  static api(message: string, status: number = 500, code?: string, data?: any): ShipError {
-    return new ShipError(ErrorType.Api, message, status, { code, data });
+  static api(message: string, status: number = 500): ShipError {
+    return new ShipError(ErrorType.Api, message, status);
   }
 
   static database(message: string, status: number = 500): ShipError {
@@ -407,15 +407,11 @@ export class ShipError extends Error {
     return new ShipError(ErrorType.Api, message, status);
   }
 
-  // Helper getters for accessing common detail properties
+  // Helper getter for accessing file path from details
   get filePath(): string | undefined {
     return this.details?.filePath;
   }
 
-  get code(): string | undefined {
-    return this.details?.code;
-  }
-
   // Helper methods for error type checking using categorization
   isClientError(): boolean {
     return ERROR_CATEGORIES.client.has(this.type);
@@ -447,6 +443,27 @@ export class ShipError extends Error {
   }
 }
 
+/**
+ * Type guard to check if an unknown value is a ShipError.
+ *
+ * Uses structural checking instead of instanceof to handle module duplication
+ * in bundled applications where multiple copies of the ShipError class may exist.
+ *
+ * @example
+ * if (isShipError(error)) {
+ *   console.log(error.status, error.message);
+ * }
+ */
+export function isShipError(error: unknown): error is ShipError {
+  return (
+    error !== null &&
+    typeof error === 'object' &&
+    'name' in error &&
+    error.name === 'ShipError' &&
+    'status' in error
+  );
+}
+
 // =============================================================================
 // CONFIG TYPES
 // =============================================================================
@@ -572,7 +589,7 @@ export function validateApiUrl(apiUrl: string): void {
       throw ShipError.validation('API URL must not contain query parameters or fragments');
     }
   } catch (error) {
-    if (error instanceof ShipError) {
+    if (isShipError(error)) {
       throw error;
     }
     throw ShipError.validation('API URL must be a valid URL');
@@ -747,6 +764,7 @@ export interface DomainResource {
   get: (name: string) => Promise<Domain>;
   remove: (name: string) => Promise<void>;
   verify: (name: string) => Promise<{ message: string }>;
+  validate: (name: string) => Promise<{ valid: boolean; normalized?: string; error?: string }>;
   dns: (name: string) => Promise<DomainDnsResponse>;
   records: (name: string) => Promise<DomainRecordsResponse>;
   share: (name: string) => Promise<{ domain: string; hash: string }>;