@shipstatic/types 0.4.7 → 0.4.9

package/dist/index.d.ts

@@ -700,10 +700,53 @@ export interface RateLimitData {
     timestamp: number;
 }
 /**
- * Generate deployment URL from deployment ID and base domain
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
+ *
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
+ */
+export declare function isPlatformDomain(domain: string, platformDomain: string): boolean;
+/**
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
+ *
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
  */
-export declare function generateDeploymentUrl(deployment: string, baseDomain?: string): string;
+export declare function isCustomDomain(domain: string, platformDomain: string): boolean;
 /**
- * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Extract subdomain from a platform domain.
+ * Returns null if not a platform domain.
+ *
+ * @example extractSubdomain("www.shipstatic.dev", "shipstatic.dev") → "www"
+ * @example extractSubdomain("example.com", "shipstatic.dev") → null
+ */
+export declare function extractSubdomain(domain: string, platformDomain: string): string | null;
+/**
+ * Generate deployment URL from deployment ID and platform domain
+ */
+export declare function generateDeploymentUrl(deployment: string, platformDomain?: string): string;
+/**
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
+ */
+export declare function generateDomainUrl(domain: 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 generateDomainUrl(domainName: string, baseDomain?: string): string;
+export declare function deserializeTags(tagsJson: string | null): string[] | undefined;

package/dist/index.js

@@ -278,24 +278,87 @@ export const FileValidationStatus = {
     READY: 'ready',
 };
 // =============================================================================
-// URL GENERATION UTILITIES
+// DOMAIN UTILITIES
 // =============================================================================
 /**
- * Generate deployment URL from deployment ID and base domain
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
+ *
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
  */
-export function generateDeploymentUrl(deployment, baseDomain) {
-    const domain = baseDomain || 'shipstatic.com';
+export function isPlatformDomain(domain, platformDomain) {
+    return domain.endsWith(`.${platformDomain}`);
+}
+/**
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
+ *
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
+ */
+export function isCustomDomain(domain, platformDomain) {
+    return !isPlatformDomain(domain, platformDomain);
+}
+/**
+ * Extract subdomain from a platform domain.
+ * Returns null if not a platform domain.
+ *
+ * @example extractSubdomain("www.shipstatic.dev", "shipstatic.dev") → "www"
+ * @example extractSubdomain("example.com", "shipstatic.dev") → null
+ */
+export function extractSubdomain(domain, platformDomain) {
+    if (!isPlatformDomain(domain, platformDomain)) {
+        return null;
+    }
+    return domain.slice(0, -(platformDomain.length + 1)); // +1 for the dot
+}
+/**
+ * Generate deployment URL from deployment ID and platform domain
+ */
+export function generateDeploymentUrl(deployment, platformDomain) {
+    const domain = platformDomain || 'shipstatic.com';
     return `https://${deployment}.${domain}`;
 }
 /**
- * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
  */
-export function generateDomainUrl(domainName, baseDomain) {
-    // If domain contains dots, it's an external domain
-    if (domainName.includes('.')) {
-        return `https://${domainName}`;
-    }
-    // Otherwise it's an internal subdomain
-    const domain = baseDomain || 'shipstatic.com';
-    return `https://${domainName}.${domain}`;
+export function generateDomainUrl(domain) {
+    return `https://${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.9",
   "description": "Shared types for Shipstatic platform",
   "type": "module",
   "main": "./dist/index.js",

package/src/index.ts

@@ -1040,27 +1040,92 @@ export interface RateLimitData {
 }
 
 // =============================================================================
-// URL GENERATION UTILITIES
+// DOMAIN UTILITIES
 // =============================================================================
 
 /**
- * Generate deployment URL from deployment ID and base domain
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
+ *
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
  */
-export function generateDeploymentUrl(deployment: string, baseDomain?: string): string {
-  const domain = baseDomain || 'shipstatic.com';
-  return `https://${deployment}.${domain}`;
+export function isPlatformDomain(domain: string, platformDomain: string): boolean {
+  return domain.endsWith(`.${platformDomain}`);
+}
+
+/**
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
+ *
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
+ */
+export function isCustomDomain(domain: string, platformDomain: string): boolean {
+  return !isPlatformDomain(domain, platformDomain);
 }
 
 /**
- * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Extract subdomain from a platform domain.
+ * Returns null if not a platform domain.
+ *
+ * @example extractSubdomain("www.shipstatic.dev", "shipstatic.dev") → "www"
+ * @example extractSubdomain("example.com", "shipstatic.dev") → null
  */
-export function generateDomainUrl(domainName: string, baseDomain?: string): string {
-  // If domain contains dots, it's an external domain
-  if (domainName.includes('.')) {
-    return `https://${domainName}`;
+export function extractSubdomain(domain: string, platformDomain: string): string | null {
+  if (!isPlatformDomain(domain, platformDomain)) {
+    return null;
   }
+  return domain.slice(0, -(platformDomain.length + 1)); // +1 for the dot
+}
+
+/**
+ * Generate deployment URL from deployment ID and platform domain
+ */
+export function generateDeploymentUrl(deployment: string, platformDomain?: string): string {
+  const domain = platformDomain || 'shipstatic.com';
+  return `https://${deployment}.${domain}`;
+}
 
-  // Otherwise it's an internal subdomain
-  const domain = baseDomain || 'shipstatic.com';
-  return `https://${domainName}.${domain}`;
+/**
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
+ */
+export function generateDomainUrl(domain: string): string {
+  return `https://${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;
+  }
 }