@shipstatic/types 0.4.7 → 0.4.8

package/dist/index.d.ts

@@ -699,6 +699,22 @@ export interface RateLimitData {
     count: number;
     timestamp: number;
 }
+/**
+ * Check if a domain is internal (a subdomain of our platform).
+ * Internal domains have no dots (e.g., "www", "my-app").
+ *
+ * @example isInternalDomain("www") → true
+ * @example isInternalDomain("example.com") → false
+ */
+export declare function isInternalDomain(domain: string): boolean;
+/**
+ * Check if a domain is external (a custom domain).
+ * External domains contain at least one dot (e.g., "example.com").
+ *
+ * @example isExternalDomain("example.com") → true
+ * @example isExternalDomain("www") → false
+ */
+export declare function isExternalDomain(domain: string): boolean;
 /**
  * Generate deployment URL from deployment ID and base domain
  */
@@ -707,3 +723,29 @@ export declare function generateDeploymentUrl(deployment: string, baseDomain?: s
  * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
  */
 export declare function generateDomainUrl(domainName: string, baseDomain?: string): string;
+/**
+ * Format domain name for display (hostname only, no protocol).
+ * Expands internal domains to full hostname.
+ *
+ * @example formatDomainName("www", "shipstatic.dev") → "www.shipstatic.dev"
+ * @example formatDomainName("example.com") → "example.com"
+ */
+export declare function formatDomainName(domainName: string, baseDomain?: string): string;
+/**
+ * Serialize tags array to JSON string for database storage.
+ * Returns null for empty or undefined arrays.
+ *
+ * @example serializeTags(['web', 'production']) → '["web","production"]'
+ * @example serializeTags([]) → null
+ * @example serializeTags(undefined) → null
+ */
+export declare function serializeTags(tags: string[] | undefined): string | null;
+/**
+ * Deserialize tags from JSON string to array.
+ * Returns undefined for null/empty strings.
+ *
+ * @example deserializeTags('["web","production"]') → ['web', 'production']
+ * @example deserializeTags(null) → undefined
+ * @example deserializeTags('') → undefined
+ */
+export declare function deserializeTags(tagsJson: string | null): string[] | undefined;

package/dist/index.js

@@ -278,8 +278,28 @@ export const FileValidationStatus = {
     READY: 'ready',
 };
 // =============================================================================
-// URL GENERATION UTILITIES
+// DOMAIN UTILITIES
 // =============================================================================
+/**
+ * Check if a domain is internal (a subdomain of our platform).
+ * Internal domains have no dots (e.g., "www", "my-app").
+ *
+ * @example isInternalDomain("www") → true
+ * @example isInternalDomain("example.com") → false
+ */
+export function isInternalDomain(domain) {
+    return !domain.includes('.');
+}
+/**
+ * Check if a domain is external (a custom domain).
+ * External domains contain at least one dot (e.g., "example.com").
+ *
+ * @example isExternalDomain("example.com") → true
+ * @example isExternalDomain("www") → false
+ */
+export function isExternalDomain(domain) {
+    return domain.includes('.');
+}
 /**
  * Generate deployment URL from deployment ID and base domain
  */
@@ -292,10 +312,61 @@ export function generateDeploymentUrl(deployment, baseDomain) {
  */
 export function generateDomainUrl(domainName, baseDomain) {
     // If domain contains dots, it's an external domain
-    if (domainName.includes('.')) {
+    if (isExternalDomain(domainName)) {
         return `https://${domainName}`;
     }
     // Otherwise it's an internal subdomain
     const domain = baseDomain || 'shipstatic.com';
     return `https://${domainName}.${domain}`;
 }
+/**
+ * Format domain name for display (hostname only, no protocol).
+ * Expands internal domains to full hostname.
+ *
+ * @example formatDomainName("www", "shipstatic.dev") → "www.shipstatic.dev"
+ * @example formatDomainName("example.com") → "example.com"
+ */
+export function formatDomainName(domainName, baseDomain) {
+    // If domain contains dots, it's an external domain - return as-is
+    if (isExternalDomain(domainName)) {
+        return domainName;
+    }
+    // Otherwise it's an internal subdomain - expand it
+    const domain = baseDomain || 'shipstatic.com';
+    return `${domainName}.${domain}`;
+}
+// =============================================================================
+// TAG UTILITIES
+// =============================================================================
+/**
+ * Serialize tags array to JSON string for database storage.
+ * Returns null for empty or undefined arrays.
+ *
+ * @example serializeTags(['web', 'production']) → '["web","production"]'
+ * @example serializeTags([]) → null
+ * @example serializeTags(undefined) → null
+ */
+export function serializeTags(tags) {
+    if (!tags || tags.length === 0)
+        return null;
+    return JSON.stringify(tags);
+}
+/**
+ * Deserialize tags from JSON string to array.
+ * Returns undefined for null/empty strings.
+ *
+ * @example deserializeTags('["web","production"]') → ['web', 'production']
+ * @example deserializeTags(null) → undefined
+ * @example deserializeTags('') → undefined
+ */
+export function deserializeTags(tagsJson) {
+    if (!tagsJson)
+        return undefined;
+    try {
+        const parsed = JSON.parse(tagsJson);
+        return Array.isArray(parsed) && parsed.length > 0 ? parsed : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}

package/package.json

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

package/src/index.ts

@@ -1040,9 +1040,31 @@ export interface RateLimitData {
 }
 
 // =============================================================================
-// URL GENERATION UTILITIES
+// DOMAIN UTILITIES
 // =============================================================================
 
+/**
+ * Check if a domain is internal (a subdomain of our platform).
+ * Internal domains have no dots (e.g., "www", "my-app").
+ *
+ * @example isInternalDomain("www") → true
+ * @example isInternalDomain("example.com") → false
+ */
+export function isInternalDomain(domain: string): boolean {
+  return !domain.includes('.');
+}
+
+/**
+ * Check if a domain is external (a custom domain).
+ * External domains contain at least one dot (e.g., "example.com").
+ *
+ * @example isExternalDomain("example.com") → true
+ * @example isExternalDomain("www") → false
+ */
+export function isExternalDomain(domain: string): boolean {
+  return domain.includes('.');
+}
+
 /**
  * Generate deployment URL from deployment ID and base domain
  */
@@ -1056,11 +1078,64 @@ export function generateDeploymentUrl(deployment: string, baseDomain?: string):
  */
 export function generateDomainUrl(domainName: string, baseDomain?: string): string {
   // If domain contains dots, it's an external domain
-  if (domainName.includes('.')) {
+  if (isExternalDomain(domainName)) {
     return `https://${domainName}`;
   }
 
   // Otherwise it's an internal subdomain
   const domain = baseDomain || 'shipstatic.com';
   return `https://${domainName}.${domain}`;
+}
+
+/**
+ * Format domain name for display (hostname only, no protocol).
+ * Expands internal domains to full hostname.
+ *
+ * @example formatDomainName("www", "shipstatic.dev") → "www.shipstatic.dev"
+ * @example formatDomainName("example.com") → "example.com"
+ */
+export function formatDomainName(domainName: string, baseDomain?: string): string {
+  // If domain contains dots, it's an external domain - return as-is
+  if (isExternalDomain(domainName)) {
+    return domainName;
+  }
+
+  // Otherwise it's an internal subdomain - expand it
+  const domain = baseDomain || 'shipstatic.com';
+  return `${domainName}.${domain}`;
+}
+
+// =============================================================================
+// TAG UTILITIES
+// =============================================================================
+
+/**
+ * Serialize tags array to JSON string for database storage.
+ * Returns null for empty or undefined arrays.
+ *
+ * @example serializeTags(['web', 'production']) → '["web","production"]'
+ * @example serializeTags([]) → null
+ * @example serializeTags(undefined) → null
+ */
+export function serializeTags(tags: string[] | undefined): string | null {
+  if (!tags || tags.length === 0) return null;
+  return JSON.stringify(tags);
+}
+
+/**
+ * Deserialize tags from JSON string to array.
+ * Returns undefined for null/empty strings.
+ *
+ * @example deserializeTags('["web","production"]') → ['web', 'production']
+ * @example deserializeTags(null) → undefined
+ * @example deserializeTags('') → undefined
+ */
+export function deserializeTags(tagsJson: string | null): string[] | undefined {
+  if (!tagsJson) return undefined;
+  try {
+    const parsed = JSON.parse(tagsJson);
+    return Array.isArray(parsed) && parsed.length > 0 ? parsed : undefined;
+  } catch {
+    return undefined;
+  }
 }