@gigadrive/sdk 0.6.1 → 0.7.0

package/dist/index.d.mts

@@ -1,3 +1,5 @@
+import { NormalizedImagePolicy } from '@gigadrive/network-config';
+
 /** The result of a credential provider's token fetch. */
 interface TokenResult {
     /** The access token to use in API requests. */
@@ -2674,6 +2676,41 @@ declare class DeploymentsResource extends BaseResource {
     getHostnames(deploymentId: string): Promise<Paginated<Hostname>>;
 }
 
+interface ImageCacheInspection {
+    enabled: boolean;
+    deploymentTag: string;
+    sourceTag: string | null;
+    policy: NormalizedImagePolicy | null;
+}
+interface ImageCachePurgeResult {
+    purged: true;
+    tag: string;
+}
+interface ManagedImageUrlOptions {
+    /** Deployment or custom application origin, for example `https://app.gigadrive.app`. */
+    origin: string;
+    /** Local application path or approved absolute remote URL. */
+    source: string;
+    filename?: string;
+    width?: number;
+    height?: number;
+    quality?: number;
+    format?: 'avif' | 'webp' | 'jpeg' | 'png';
+    fit?: 'contain' | 'cover' | 'fill' | 'inside' | 'outside';
+    variant?: string;
+}
+/** Creates the stable, framework-neutral managed image URL served on an application hostname. */
+declare const createManagedImageUrl: (options: ManagedImageUrlOptions) => string;
+/** Managed image optimization cache inspection and source/deployment purge operations. */
+declare class ImageOptimizationResource extends BaseResource {
+    /** Create a managed image URL without making an API request. */
+    url(options: ManagedImageUrlOptions): string;
+    /** Inspect the immutable deployment policy and Bunny cache tags used for a source. */
+    inspect(deploymentId: string, source?: string): Promise<ImageCacheInspection>;
+    /** Purge all variants for one source, or every optimized image in the deployment when omitted. */
+    purge(deploymentId: string, source?: string): Promise<ImageCachePurgeResult>;
+}
+
 /** Input for minting a routing-only sticky session URL. */
 interface CreateStickySessionUrlInput {
     /** Opaque application key shared by callers that must reach the same instance. */
@@ -2860,6 +2897,8 @@ declare class GigadriveClient {
     readonly apiKeys: ApiKeysResource;
     /** Signed URLs that keep related requests on one MicroVM instance. */
     readonly stickySessions: StickySessionsResource;
+    /** Managed image optimization inspection and cache purge operations. */
+    readonly imageOptimization: ImageOptimizationResource;
     constructor(config?: GigadriveClientConfig);
 }
 
@@ -2998,4 +3037,4 @@ declare function paginate<T>(fetchPage: (cursor: string | undefined) => Promise<
  */
 declare function parseSSEStream<T = unknown>(response: Response): AsyncGenerator<T>;
 
-export { AiGatewayAudioResource, type AiGatewayBudget, type AiGatewayBudgetInput, AiGatewayBudgetsResource, AiGatewayPoliciesResource, type AiGatewayPolicy, type AiGatewayPolicyInput, type AiGatewayProviderAttempt, type AiGatewayRequestEvent, type AiGatewayRequestsQuery, AiGatewayResource, type AiGatewayUsageBreakdown, type AiGatewayUsageQuery, AiGatewayUsageResource, type AiGatewayUsageSummary, AiGatewayVideosResource, type AiModel, type AiModelCapabilities, type AiModelRoutingProvider, ApiError, type ApiKey, ApiKeysResource, type Application, ApplicationEnvVarsResource, type ApplicationHostnameList, ApplicationRequestsResource, ApplicationStorageResource, ApplicationsResource, AuthenticationError, type ChatCompletionChoice, type ChatCompletionChunk, type ChatCompletionContentPart, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionUsage, type CreateApiKeyInput, type CreateApiKeyResult, type CreateDeploymentInput, type CreateEnvVarInput, type CreateOrganizationInput, type CreateStickySessionUrlInput, type CreateStickySessionUrlResult, type CreateStorageBucketInput, type CreateUploadSessionInput, type CreateUploadSessionResponse, type Deployment, type DeploymentLog, type DeploymentLogPage, type DeploymentLogType, type DeploymentStatus, DeploymentsResource, type EnvVar, type GatewayRequestOptions, type GatewayResult, GigadriveClient, type GigadriveClientConfig, GigadriveError, type Hostname, type HostnameAvailability, type ListApiKeysQuery, type ListApplicationsQuery, type ListDeploymentLogsQuery, type ListDeploymentsQuery, type ListQuery, type ListRequestsQuery, type ListStorageObjectsQuery, type NetworkRequest, type NetworkRequestApplicationRef, type NetworkRequestAssetRef, type NetworkRequestBucketRef, type NetworkRequestDeploymentRef, type NetworkRequestDetails, type NetworkRequestFunctionRef, type NetworkRequestMetrics, type NetworkRequestObjectRef, type NetworkRequestSummary, type NetworkResponseDetails, type NodeReadableLike, type Organization, OrganizationAiGatewayResource, OrganizationEnvVarsResource, type OrganizationMember, OrganizationMembersResource, type OrganizationMembershipRole, type OrganizationProductAccess, type OrganizationProductEntitlement, type OrganizationProductEntitlementCheck, type OrganizationProductSubscription, OrganizationProductsResource, OrganizationsResource, type Paginated, type PresignedUrlResult, type ProductAccessMode, type ProductAccessResolutionSource, type ProductDefaultAccessPolicy, type ProductDefinition, type ProductEntitlementStatus, type ProductPlan, type ProductSubscriptionStatus, type ProviderRouting, type PullEnvVarsQuery, type PullEnvVarsResult, type QueryValue, type ResolvedEnvVar, type ResponsesRequest, type ResponsesResponse, type RunUploadOptions, type SetProductionHostnameResult, type SpeechRequest, type StartUploadResult, StickySessionsResource, type StorageBucket, StorageBucketsResource, type StorageObject, type StorageObjectAccess, type StorageObjectList, StorageObjectsResource, type StorageUploadSession, StorageUploadSessionsResource, type TranscriptionRequest, type TranscriptionResponse, type UpdateEnvVarInput, type UploadBatchItemResult, type UploadBatchOptions, type UploadByteSource, type UploadData, UploadError, type UploadFileInput, type UploadFileResult, type UploadPart, UploadSessionExpiredError, type UploadUrlStorage, type VideoGenerationRequest, type VideoGenerationResponse, type VideoModelList, type WaitForCompletionOptions, paginate, parseSSEStream };
+export { AiGatewayAudioResource, type AiGatewayBudget, type AiGatewayBudgetInput, AiGatewayBudgetsResource, AiGatewayPoliciesResource, type AiGatewayPolicy, type AiGatewayPolicyInput, type AiGatewayProviderAttempt, type AiGatewayRequestEvent, type AiGatewayRequestsQuery, AiGatewayResource, type AiGatewayUsageBreakdown, type AiGatewayUsageQuery, AiGatewayUsageResource, type AiGatewayUsageSummary, AiGatewayVideosResource, type AiModel, type AiModelCapabilities, type AiModelRoutingProvider, ApiError, type ApiKey, ApiKeysResource, type Application, ApplicationEnvVarsResource, type ApplicationHostnameList, ApplicationRequestsResource, ApplicationStorageResource, ApplicationsResource, AuthenticationError, type ChatCompletionChoice, type ChatCompletionChunk, type ChatCompletionContentPart, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionUsage, type CreateApiKeyInput, type CreateApiKeyResult, type CreateDeploymentInput, type CreateEnvVarInput, type CreateOrganizationInput, type CreateStickySessionUrlInput, type CreateStickySessionUrlResult, type CreateStorageBucketInput, type CreateUploadSessionInput, type CreateUploadSessionResponse, type Deployment, type DeploymentLog, type DeploymentLogPage, type DeploymentLogType, type DeploymentStatus, DeploymentsResource, type EnvVar, type GatewayRequestOptions, type GatewayResult, GigadriveClient, type GigadriveClientConfig, GigadriveError, type Hostname, type HostnameAvailability, type ImageCacheInspection, type ImageCachePurgeResult, ImageOptimizationResource, type ListApiKeysQuery, type ListApplicationsQuery, type ListDeploymentLogsQuery, type ListDeploymentsQuery, type ListQuery, type ListRequestsQuery, type ListStorageObjectsQuery, type ManagedImageUrlOptions, type NetworkRequest, type NetworkRequestApplicationRef, type NetworkRequestAssetRef, type NetworkRequestBucketRef, type NetworkRequestDeploymentRef, type NetworkRequestDetails, type NetworkRequestFunctionRef, type NetworkRequestMetrics, type NetworkRequestObjectRef, type NetworkRequestSummary, type NetworkResponseDetails, type NodeReadableLike, type Organization, OrganizationAiGatewayResource, OrganizationEnvVarsResource, type OrganizationMember, OrganizationMembersResource, type OrganizationMembershipRole, type OrganizationProductAccess, type OrganizationProductEntitlement, type OrganizationProductEntitlementCheck, type OrganizationProductSubscription, OrganizationProductsResource, OrganizationsResource, type Paginated, type PresignedUrlResult, type ProductAccessMode, type ProductAccessResolutionSource, type ProductDefaultAccessPolicy, type ProductDefinition, type ProductEntitlementStatus, type ProductPlan, type ProductSubscriptionStatus, type ProviderRouting, type PullEnvVarsQuery, type PullEnvVarsResult, type QueryValue, type ResolvedEnvVar, type ResponsesRequest, type ResponsesResponse, type RunUploadOptions, type SetProductionHostnameResult, type SpeechRequest, type StartUploadResult, StickySessionsResource, type StorageBucket, StorageBucketsResource, type StorageObject, type StorageObjectAccess, type StorageObjectList, StorageObjectsResource, type StorageUploadSession, StorageUploadSessionsResource, type TranscriptionRequest, type TranscriptionResponse, type UpdateEnvVarInput, type UploadBatchItemResult, type UploadBatchOptions, type UploadByteSource, type UploadData, UploadError, type UploadFileInput, type UploadFileResult, type UploadPart, UploadSessionExpiredError, type UploadUrlStorage, type VideoGenerationRequest, type VideoGenerationResponse, type VideoModelList, type WaitForCompletionOptions, createManagedImageUrl, paginate, parseSSEStream };

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { NormalizedImagePolicy } from '@gigadrive/network-config';
+
 /** The result of a credential provider's token fetch. */
 interface TokenResult {
     /** The access token to use in API requests. */
@@ -2674,6 +2676,41 @@ declare class DeploymentsResource extends BaseResource {
     getHostnames(deploymentId: string): Promise<Paginated<Hostname>>;
 }
 
+interface ImageCacheInspection {
+    enabled: boolean;
+    deploymentTag: string;
+    sourceTag: string | null;
+    policy: NormalizedImagePolicy | null;
+}
+interface ImageCachePurgeResult {
+    purged: true;
+    tag: string;
+}
+interface ManagedImageUrlOptions {
+    /** Deployment or custom application origin, for example `https://app.gigadrive.app`. */
+    origin: string;
+    /** Local application path or approved absolute remote URL. */
+    source: string;
+    filename?: string;
+    width?: number;
+    height?: number;
+    quality?: number;
+    format?: 'avif' | 'webp' | 'jpeg' | 'png';
+    fit?: 'contain' | 'cover' | 'fill' | 'inside' | 'outside';
+    variant?: string;
+}
+/** Creates the stable, framework-neutral managed image URL served on an application hostname. */
+declare const createManagedImageUrl: (options: ManagedImageUrlOptions) => string;
+/** Managed image optimization cache inspection and source/deployment purge operations. */
+declare class ImageOptimizationResource extends BaseResource {
+    /** Create a managed image URL without making an API request. */
+    url(options: ManagedImageUrlOptions): string;
+    /** Inspect the immutable deployment policy and Bunny cache tags used for a source. */
+    inspect(deploymentId: string, source?: string): Promise<ImageCacheInspection>;
+    /** Purge all variants for one source, or every optimized image in the deployment when omitted. */
+    purge(deploymentId: string, source?: string): Promise<ImageCachePurgeResult>;
+}
+
 /** Input for minting a routing-only sticky session URL. */
 interface CreateStickySessionUrlInput {
     /** Opaque application key shared by callers that must reach the same instance. */
@@ -2860,6 +2897,8 @@ declare class GigadriveClient {
     readonly apiKeys: ApiKeysResource;
     /** Signed URLs that keep related requests on one MicroVM instance. */
     readonly stickySessions: StickySessionsResource;
+    /** Managed image optimization inspection and cache purge operations. */
+    readonly imageOptimization: ImageOptimizationResource;
     constructor(config?: GigadriveClientConfig);
 }
 
@@ -2998,4 +3037,4 @@ declare function paginate<T>(fetchPage: (cursor: string | undefined) => Promise<
  */
 declare function parseSSEStream<T = unknown>(response: Response): AsyncGenerator<T>;
 
-export { AiGatewayAudioResource, type AiGatewayBudget, type AiGatewayBudgetInput, AiGatewayBudgetsResource, AiGatewayPoliciesResource, type AiGatewayPolicy, type AiGatewayPolicyInput, type AiGatewayProviderAttempt, type AiGatewayRequestEvent, type AiGatewayRequestsQuery, AiGatewayResource, type AiGatewayUsageBreakdown, type AiGatewayUsageQuery, AiGatewayUsageResource, type AiGatewayUsageSummary, AiGatewayVideosResource, type AiModel, type AiModelCapabilities, type AiModelRoutingProvider, ApiError, type ApiKey, ApiKeysResource, type Application, ApplicationEnvVarsResource, type ApplicationHostnameList, ApplicationRequestsResource, ApplicationStorageResource, ApplicationsResource, AuthenticationError, type ChatCompletionChoice, type ChatCompletionChunk, type ChatCompletionContentPart, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionUsage, type CreateApiKeyInput, type CreateApiKeyResult, type CreateDeploymentInput, type CreateEnvVarInput, type CreateOrganizationInput, type CreateStickySessionUrlInput, type CreateStickySessionUrlResult, type CreateStorageBucketInput, type CreateUploadSessionInput, type CreateUploadSessionResponse, type Deployment, type DeploymentLog, type DeploymentLogPage, type DeploymentLogType, type DeploymentStatus, DeploymentsResource, type EnvVar, type GatewayRequestOptions, type GatewayResult, GigadriveClient, type GigadriveClientConfig, GigadriveError, type Hostname, type HostnameAvailability, type ListApiKeysQuery, type ListApplicationsQuery, type ListDeploymentLogsQuery, type ListDeploymentsQuery, type ListQuery, type ListRequestsQuery, type ListStorageObjectsQuery, type NetworkRequest, type NetworkRequestApplicationRef, type NetworkRequestAssetRef, type NetworkRequestBucketRef, type NetworkRequestDeploymentRef, type NetworkRequestDetails, type NetworkRequestFunctionRef, type NetworkRequestMetrics, type NetworkRequestObjectRef, type NetworkRequestSummary, type NetworkResponseDetails, type NodeReadableLike, type Organization, OrganizationAiGatewayResource, OrganizationEnvVarsResource, type OrganizationMember, OrganizationMembersResource, type OrganizationMembershipRole, type OrganizationProductAccess, type OrganizationProductEntitlement, type OrganizationProductEntitlementCheck, type OrganizationProductSubscription, OrganizationProductsResource, OrganizationsResource, type Paginated, type PresignedUrlResult, type ProductAccessMode, type ProductAccessResolutionSource, type ProductDefaultAccessPolicy, type ProductDefinition, type ProductEntitlementStatus, type ProductPlan, type ProductSubscriptionStatus, type ProviderRouting, type PullEnvVarsQuery, type PullEnvVarsResult, type QueryValue, type ResolvedEnvVar, type ResponsesRequest, type ResponsesResponse, type RunUploadOptions, type SetProductionHostnameResult, type SpeechRequest, type StartUploadResult, StickySessionsResource, type StorageBucket, StorageBucketsResource, type StorageObject, type StorageObjectAccess, type StorageObjectList, StorageObjectsResource, type StorageUploadSession, StorageUploadSessionsResource, type TranscriptionRequest, type TranscriptionResponse, type UpdateEnvVarInput, type UploadBatchItemResult, type UploadBatchOptions, type UploadByteSource, type UploadData, UploadError, type UploadFileInput, type UploadFileResult, type UploadPart, UploadSessionExpiredError, type UploadUrlStorage, type VideoGenerationRequest, type VideoGenerationResponse, type VideoModelList, type WaitForCompletionOptions, paginate, parseSSEStream };
+export { AiGatewayAudioResource, type AiGatewayBudget, type AiGatewayBudgetInput, AiGatewayBudgetsResource, AiGatewayPoliciesResource, type AiGatewayPolicy, type AiGatewayPolicyInput, type AiGatewayProviderAttempt, type AiGatewayRequestEvent, type AiGatewayRequestsQuery, AiGatewayResource, type AiGatewayUsageBreakdown, type AiGatewayUsageQuery, AiGatewayUsageResource, type AiGatewayUsageSummary, AiGatewayVideosResource, type AiModel, type AiModelCapabilities, type AiModelRoutingProvider, ApiError, type ApiKey, ApiKeysResource, type Application, ApplicationEnvVarsResource, type ApplicationHostnameList, ApplicationRequestsResource, ApplicationStorageResource, ApplicationsResource, AuthenticationError, type ChatCompletionChoice, type ChatCompletionChunk, type ChatCompletionContentPart, type ChatCompletionMessage, type ChatCompletionRequest, type ChatCompletionResponse, type ChatCompletionUsage, type CreateApiKeyInput, type CreateApiKeyResult, type CreateDeploymentInput, type CreateEnvVarInput, type CreateOrganizationInput, type CreateStickySessionUrlInput, type CreateStickySessionUrlResult, type CreateStorageBucketInput, type CreateUploadSessionInput, type CreateUploadSessionResponse, type Deployment, type DeploymentLog, type DeploymentLogPage, type DeploymentLogType, type DeploymentStatus, DeploymentsResource, type EnvVar, type GatewayRequestOptions, type GatewayResult, GigadriveClient, type GigadriveClientConfig, GigadriveError, type Hostname, type HostnameAvailability, type ImageCacheInspection, type ImageCachePurgeResult, ImageOptimizationResource, type ListApiKeysQuery, type ListApplicationsQuery, type ListDeploymentLogsQuery, type ListDeploymentsQuery, type ListQuery, type ListRequestsQuery, type ListStorageObjectsQuery, type ManagedImageUrlOptions, type NetworkRequest, type NetworkRequestApplicationRef, type NetworkRequestAssetRef, type NetworkRequestBucketRef, type NetworkRequestDeploymentRef, type NetworkRequestDetails, type NetworkRequestFunctionRef, type NetworkRequestMetrics, type NetworkRequestObjectRef, type NetworkRequestSummary, type NetworkResponseDetails, type NodeReadableLike, type Organization, OrganizationAiGatewayResource, OrganizationEnvVarsResource, type OrganizationMember, OrganizationMembersResource, type OrganizationMembershipRole, type OrganizationProductAccess, type OrganizationProductEntitlement, type OrganizationProductEntitlementCheck, type OrganizationProductSubscription, OrganizationProductsResource, OrganizationsResource, type Paginated, type PresignedUrlResult, type ProductAccessMode, type ProductAccessResolutionSource, type ProductDefaultAccessPolicy, type ProductDefinition, type ProductEntitlementStatus, type ProductPlan, type ProductSubscriptionStatus, type ProviderRouting, type PullEnvVarsQuery, type PullEnvVarsResult, type QueryValue, type ResolvedEnvVar, type ResponsesRequest, type ResponsesResponse, type RunUploadOptions, type SetProductionHostnameResult, type SpeechRequest, type StartUploadResult, StickySessionsResource, type StorageBucket, StorageBucketsResource, type StorageObject, type StorageObjectAccess, type StorageObjectList, StorageObjectsResource, type StorageUploadSession, StorageUploadSessionsResource, type TranscriptionRequest, type TranscriptionResponse, type UpdateEnvVarInput, type UploadBatchItemResult, type UploadBatchOptions, type UploadByteSource, type UploadData, UploadError, type UploadFileInput, type UploadFileResult, type UploadPart, UploadSessionExpiredError, type UploadUrlStorage, type VideoGenerationRequest, type VideoGenerationResponse, type VideoModelList, type WaitForCompletionOptions, createManagedImageUrl, paginate, parseSSEStream };

package/dist/index.js

@@ -46,6 +46,7 @@ __export(src_exports, {
   DeploymentsResource: () => DeploymentsResource,
   GigadriveClient: () => GigadriveClient,
   GigadriveError: () => GigadriveError,
+  ImageOptimizationResource: () => ImageOptimizationResource,
   OrganizationAiGatewayResource: () => OrganizationAiGatewayResource,
   OrganizationEnvVarsResource: () => OrganizationEnvVarsResource,
   OrganizationMembersResource: () => OrganizationMembersResource,
@@ -57,6 +58,7 @@ __export(src_exports, {
   StorageUploadSessionsResource: () => StorageUploadSessionsResource,
   UploadError: () => UploadError,
   UploadSessionExpiredError: () => UploadSessionExpiredError,
+  createManagedImageUrl: () => createManagedImageUrl,
   paginate: () => paginate,
   parseSSEStream: () => parseSSEStream
 });
@@ -1967,6 +1969,45 @@ var DeploymentsResource = class extends BaseResource {
   }
 };
 
+// src/resources/image-optimization.ts
+var createManagedImageUrl = (options) => {
+  const inferredFilename = options.source.split("/").filter(Boolean).at(-1)?.split("?")[0] || "image.image";
+  const filename = (options.filename ?? inferredFilename).replace(/[^A-Za-z0-9._-]/g, "_") || "image.image";
+  const url = new URL(
+    `/_gigadrive/image/${encodeURIComponent(options.source)}/${encodeURIComponent(filename)}`,
+    options.origin
+  );
+  for (const [name, value] of Object.entries({
+    width: options.width,
+    height: options.height,
+    quality: options.quality,
+    format: options.format,
+    fit: options.fit,
+    variant: options.variant
+  })) {
+    if (value !== void 0) url.searchParams.set(name, String(value));
+  }
+  return url.toString();
+};
+var ImageOptimizationResource = class extends BaseResource {
+  /** Create a managed image URL without making an API request. */
+  url(options) {
+    return createManagedImageUrl(options);
+  }
+  /** Inspect the immutable deployment policy and Bunny cache tags used for a source. */
+  inspect(deploymentId, source) {
+    return this.httpClient.get(`/deployments/${deploymentId}/image-cache`, {
+      query: { source }
+    });
+  }
+  /** Purge all variants for one source, or every optimized image in the deployment when omitted. */
+  purge(deploymentId, source) {
+    return this.httpClient.delete(`/deployments/${deploymentId}/image-cache`, {
+      query: { source }
+    });
+  }
+};
+
 // src/resources/organization-ai-gateway.ts
 var AiGatewayUsageResource = class extends BaseResource {
   /** Get an aggregated usage summary with breakdowns by model, provider, and user. */
@@ -2331,6 +2372,8 @@ var GigadriveClient = class {
   apiKeys;
   /** Signed URLs that keep related requests on one MicroVM instance. */
   stickySessions;
+  /** Managed image optimization inspection and cache purge operations. */
+  imageOptimization;
   constructor(config = {}) {
     const baseUrl = config.baseUrl ?? readEnv("GIGADRIVE_API_BASE_URL") ?? DEFAULT_BASE_URL2;
     const fetchFn = config.fetch ?? globalThis.fetch.bind(globalThis);
@@ -2343,6 +2386,7 @@ var GigadriveClient = class {
     this.aiGateway = new AiGatewayResource(httpClient);
     this.apiKeys = new ApiKeysResource(httpClient);
     this.stickySessions = new StickySessionsResource(httpClient);
+    this.imageOptimization = new ImageOptimizationResource(httpClient);
   }
 };
 
@@ -2375,6 +2419,7 @@ async function* paginate(fetchPage) {
   DeploymentsResource,
   GigadriveClient,
   GigadriveError,
+  ImageOptimizationResource,
   OrganizationAiGatewayResource,
   OrganizationEnvVarsResource,
   OrganizationMembersResource,
@@ -2386,6 +2431,7 @@ async function* paginate(fetchPage) {
   StorageUploadSessionsResource,
   UploadError,
   UploadSessionExpiredError,
+  createManagedImageUrl,
   paginate,
   parseSSEStream
 });