@shipstatic/types 0.4.8 → 0.4.10

package/README.md

@@ -55,7 +55,7 @@ import type { DeploymentResource, DomainResource, AccountResource } from '@ships
 ### Validation Utilities
 
 ```typescript
-import { validateApiKey, validateDeployToken, validateSubdomain } from '@shipstatic/types';
+import { validateApiKey, validateDeployToken, isDeployment } from '@shipstatic/types';
 ```
 
 ### Constants

package/dist/index.d.ts

@@ -364,9 +364,10 @@ export declare function validateDeployToken(deployToken: string): void;
  */
 export declare function validateApiUrl(apiUrl: string): void;
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export declare function validateSubdomain(input: string): boolean;
+export declare function isDeployment(input: string): boolean;
 /**
  * Request payload for SPA check endpoint
  */
@@ -700,37 +701,38 @@ export interface RateLimitData {
     timestamp: number;
 }
 /**
- * Check if a domain is internal (a subdomain of our platform).
- * Internal domains have no dots (e.g., "www", "my-app").
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
  *
- * @example isInternalDomain("www") → true
- * @example isInternalDomain("example.com") → false
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
  */
-export declare function isInternalDomain(domain: string): boolean;
+export declare function isPlatformDomain(domain: string, platformDomain: string): boolean;
 /**
- * Check if a domain is external (a custom domain).
- * External domains contain at least one dot (e.g., "example.com").
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
  *
- * @example isExternalDomain("example.com") → true
- * @example isExternalDomain("www") → false
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
  */
-export declare function isExternalDomain(domain: string): boolean;
+export declare function isCustomDomain(domain: string, platformDomain: string): boolean;
 /**
- * Generate deployment URL from deployment ID and base 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 generateDeploymentUrl(deployment: string, baseDomain?: string): string;
+export declare function extractSubdomain(domain: string, platformDomain: string): string | null;
 /**
- * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Generate deployment URL from deployment ID and platform domain
  */
-export declare function generateDomainUrl(domainName: string, baseDomain?: string): string;
+export declare function generateDeploymentUrl(deployment: string, platformDomain?: 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"
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
  */
-export declare function formatDomainName(domainName: string, baseDomain?: string): string;
+export declare function generateDomainUrl(domain: string): string;
 /**
  * Serialize tags array to JSON string for database storage.
  * Returns null for empty or undefined arrays.

package/dist/index.js

@@ -253,10 +253,10 @@ export function validateApiUrl(apiUrl) {
     }
 }
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export function validateSubdomain(input) {
-    // Deployment subdomain format: word-word-7chars (e.g. "happy-cat-abc1234")
+export function isDeployment(input) {
     return /^[a-z]+-[a-z]+-[a-z0-9]{7}$/i.test(input);
 }
 // =============================================================================
@@ -281,59 +281,51 @@ export const FileValidationStatus = {
 // DOMAIN UTILITIES
 // =============================================================================
 /**
- * Check if a domain is internal (a subdomain of our platform).
- * Internal domains have no dots (e.g., "www", "my-app").
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
  *
- * @example isInternalDomain("www") → true
- * @example isInternalDomain("example.com") → false
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
  */
-export function isInternalDomain(domain) {
-    return !domain.includes('.');
+export function isPlatformDomain(domain, platformDomain) {
+    return domain.endsWith(`.${platformDomain}`);
 }
 /**
- * Check if a domain is external (a custom domain).
- * External domains contain at least one dot (e.g., "example.com").
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
  *
- * @example isExternalDomain("example.com") → true
- * @example isExternalDomain("www") → false
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
  */
-export function isExternalDomain(domain) {
-    return domain.includes('.');
+export function isCustomDomain(domain, platformDomain) {
+    return !isPlatformDomain(domain, platformDomain);
 }
 /**
- * Generate deployment URL from deployment ID and base 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 generateDeploymentUrl(deployment, baseDomain) {
-    const domain = baseDomain || 'shipstatic.com';
-    return `https://${deployment}.${domain}`;
+export function extractSubdomain(domain, platformDomain) {
+    if (!isPlatformDomain(domain, platformDomain)) {
+        return null;
+    }
+    return domain.slice(0, -(platformDomain.length + 1)); // +1 for the dot
 }
 /**
- * Generate domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Generate deployment URL from deployment ID and platform domain
  */
-export function generateDomainUrl(domainName, baseDomain) {
-    // If domain contains dots, it's an external domain
-    if (isExternalDomain(domainName)) {
-        return `https://${domainName}`;
-    }
-    // Otherwise it's an internal subdomain
-    const domain = baseDomain || 'shipstatic.com';
-    return `https://${domainName}.${domain}`;
+export function generateDeploymentUrl(deployment, platformDomain) {
+    const domain = platformDomain || 'shipstatic.com';
+    return `https://${deployment}.${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"
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
  */
-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}`;
+export function generateDomainUrl(domain) {
+    return `https://${domain}`;
 }
 // =============================================================================
 // TAG UTILITIES

package/package.json

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

package/src/index.ts

@@ -580,10 +580,10 @@ export function validateApiUrl(apiUrl: string): void {
 }
 
 /**
- * Validate subdomain format (deployment pattern)
+ * Check if a string matches the deployment ID pattern (word-word-alphanumeric7)
+ * Example: "happy-cat-abc1234"
  */
-export function validateSubdomain(input: string): boolean {
-  // Deployment subdomain format: word-word-7chars (e.g. "happy-cat-abc1234")
+export function isDeployment(input: string): boolean {
   return /^[a-z]+-[a-z]+-[a-z0-9]{7}$/i.test(input);
 }
 
@@ -1044,65 +1044,55 @@ export interface RateLimitData {
 // =============================================================================
 
 /**
- * Check if a domain is internal (a subdomain of our platform).
- * Internal domains have no dots (e.g., "www", "my-app").
+ * Check if a domain is a platform domain (subdomain of our platform).
+ * Platform domains are free and don't require DNS verification.
  *
- * @example isInternalDomain("www") → true
- * @example isInternalDomain("example.com") → false
+ * @example isPlatformDomain("www.shipstatic.dev", "shipstatic.dev") → true
+ * @example isPlatformDomain("example.com", "shipstatic.dev") → false
  */
-export function isInternalDomain(domain: string): boolean {
-  return !domain.includes('.');
+export function isPlatformDomain(domain: string, platformDomain: string): boolean {
+  return domain.endsWith(`.${platformDomain}`);
 }
 
 /**
- * Check if a domain is external (a custom domain).
- * External domains contain at least one dot (e.g., "example.com").
+ * Check if a domain is a custom domain (not a platform subdomain).
+ * Custom domains are billable and require DNS verification.
  *
- * @example isExternalDomain("example.com") → true
- * @example isExternalDomain("www") → false
+ * @example isCustomDomain("example.com", "shipstatic.dev") → true
+ * @example isCustomDomain("www.shipstatic.dev", "shipstatic.dev") → false
  */
-export function isExternalDomain(domain: string): boolean {
-  return domain.includes('.');
+export function isCustomDomain(domain: string, platformDomain: string): boolean {
+  return !isPlatformDomain(domain, platformDomain);
 }
 
 /**
- * Generate deployment URL from deployment ID and base 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 generateDeploymentUrl(deployment: string, baseDomain?: string): string {
-  const domain = baseDomain || 'shipstatic.com';
-  return `https://${deployment}.${domain}`;
+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 domain URL based on whether it's internal (subdomain) or external (custom domain)
+ * Generate deployment URL from deployment ID and platform domain
  */
-export function generateDomainUrl(domainName: string, baseDomain?: string): string {
-  // If domain contains dots, it's an external domain
-  if (isExternalDomain(domainName)) {
-    return `https://${domainName}`;
-  }
-
-  // Otherwise it's an internal subdomain
-  const domain = baseDomain || 'shipstatic.com';
-  return `https://${domainName}.${domain}`;
+export function generateDeploymentUrl(deployment: string, platformDomain?: string): string {
+  const domain = platformDomain || 'shipstatic.com';
+  return `https://${deployment}.${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"
+ * Generate URL for a domain.
+ * Domains are stored as FQDNs, so this just prepends https://
  */
-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}`;
+export function generateDomainUrl(domain: string): string {
+  return `https://${domain}`;
 }
 
 // =============================================================================