@plyaz/types 1.31.0 → 1.32.0

package/dist/api/index.d.ts

@@ -10,6 +10,7 @@ export * from './debugger/enums';
 export * from './client/enum';
 export * from './regional/enum';
 export * from './pubsub/enum';
+export * from './endpoints/files/schemas';
 export type * from './events/types';
 export type * from './events/factories';
 export type * from './events/queue';
@@ -42,6 +43,7 @@ export type * from './endpoints/types';
 export type * from './endpoints/health/types';
 export type * from './endpoints/campaigns/types';
 export type * from './endpoints/featureFlags';
+export type * from './endpoints/files';
 export type * from './endpoints/infobip/types';
 export type * from './endpoints/virustotal/types';
 export type * from './endpoints/cdn/types';

package/dist/api/index.js

@@ -1,3 +1,5 @@
+import { z } from 'zod';
+
 // @plyaz package - Built with tsup
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
@@ -500,6 +502,204 @@ var PUB_SUB_EVENT = {
   RequestError: "request:error",
   RequestAbort: "request:abort"
 };
+var PDF_SCALE_MIN = 0.1;
+var PDF_SCALE_MAX = 2;
+var MAX_BULK_UPLOAD_CONCURRENCY = 10;
+var OutputFormatSchema = z.enum(["pdf", "docx", "xlsx", "html"]);
+var AccessLevelSchema = z.enum(["public", "private", "protected"]);
+var PdfOptionsSchema = z.object({
+  format: z.enum(["A4", "Letter", "Legal"]).optional(),
+  landscape: z.boolean().optional(),
+  margin: z.object({
+    top: z.string().optional(),
+    right: z.string().optional(),
+    bottom: z.string().optional(),
+    left: z.string().optional()
+  }).optional(),
+  displayHeaderFooter: z.boolean().optional(),
+  headerTemplate: z.string().optional(),
+  footerTemplate: z.string().optional(),
+  printBackground: z.boolean().optional(),
+  scale: z.number().min(PDF_SCALE_MIN).max(PDF_SCALE_MAX).optional()
+}).optional();
+var UploadFileRequestSchema = z.object({
+  // Direct File Upload (base64)
+  base64: z.string().optional(),
+  mimeType: z.string().optional(),
+  filename: z.string().optional(),
+  // Template-Based Generation
+  templateId: z.string().optional(),
+  templateData: z.record(z.string(), z.unknown()).optional(),
+  outputFormat: OutputFormatSchema.optional(),
+  locale: z.string().optional(),
+  pdfOptions: PdfOptionsSchema,
+  // Path Generation & Storage (required)
+  category: z.string(),
+  entityType: z.string(),
+  entityId: z.string(),
+  // Optional Metadata
+  accessLevel: AccessLevelSchema.optional(),
+  customMetadata: z.record(z.string(), z.unknown()).optional(),
+  tags: z.array(z.string()).optional(),
+  customPath: z.string().optional(),
+  ttl: z.number().positive().optional(),
+  immutable: z.boolean().optional(),
+  // Processing Options
+  extractMetadata: z.boolean().optional(),
+  virusScan: z.boolean().optional(),
+  processMedia: z.boolean().optional()
+}).refine(
+  (data) => {
+    return Boolean(data.base64) || Boolean(data.templateId);
+  },
+  {
+    message: "Either base64 content or templateId must be provided"
+  }
+).refine(
+  (data) => {
+    if (data.base64 && !data.mimeType) {
+      return false;
+    }
+    return true;
+  },
+  {
+    message: "mimeType is required when base64 content is provided"
+  }
+);
+var FileVariantSchema = z.object({
+  url: z.string().url(),
+  size: z.number().nonnegative(),
+  mimeType: z.string()
+});
+var UploadFileResponseSchema = z.object({
+  // Core identifiers
+  id: z.string(),
+  key: z.string(),
+  filename: z.string(),
+  mimeType: z.string(),
+  size: z.number().nonnegative(),
+  checksum: z.string().optional(),
+  // URLs
+  url: z.string().optional(),
+  publicUrl: z.string().optional(),
+  signedUrl: z.string().optional(),
+  // Storage Info
+  bucket: z.string(),
+  adapter: z.string().optional(),
+  entityType: z.string().optional(),
+  entityId: z.string().optional(),
+  category: z.string().optional(),
+  // Timestamps
+  uploadedAt: z.string(),
+  expiresAt: z.string().optional(),
+  // Variants
+  variants: z.record(z.string(), FileVariantSchema).optional(),
+  // Warnings
+  warnings: z.array(z.string()).optional()
+});
+var UploadFileItemSchema = UploadFileRequestSchema;
+var UploadFilesRequestSchema = z.object({
+  /** Array of files to upload */
+  files: z.array(UploadFileItemSchema).min(1, "At least one file is required"),
+  /** Options for bulk upload */
+  options: z.object({
+    /** Max concurrent uploads (default: 3, max: 10) */
+    concurrency: z.number().min(1).max(MAX_BULK_UPLOAD_CONCURRENCY).optional(),
+    /** Continue uploading remaining files if one fails */
+    continueOnError: z.boolean().optional(),
+    /** Use queue for background processing */
+    useQueue: z.boolean().optional()
+  }).optional()
+});
+var UploadFileResultSchema = z.object({
+  /** Index in original files array */
+  index: z.number().nonnegative(),
+  /** Whether this file uploaded successfully */
+  success: z.boolean(),
+  /** Upload result (when success=true) */
+  data: UploadFileResponseSchema.optional(),
+  /** Error message (when success=false) */
+  error: z.string().optional()
+});
+var UploadFilesResponseSchema = z.object({
+  /** Individual results for each file */
+  results: z.array(UploadFileResultSchema),
+  /** Summary statistics */
+  summary: z.object({
+    total: z.number().nonnegative(),
+    succeeded: z.number().nonnegative(),
+    failed: z.number().nonnegative()
+  }),
+  /** Whether all files uploaded successfully */
+  allSucceeded: z.boolean()
+});
+var GenerateDocumentRequestSchema = z.object({
+  templateId: z.string(),
+  templateData: z.record(z.string(), z.unknown()),
+  outputFormat: OutputFormatSchema.optional().default("pdf"),
+  locale: z.string().optional(),
+  pdfOptions: PdfOptionsSchema
+});
+var GenerateDocumentResponseSchema = z.object({
+  buffer: z.string(),
+  // base64 encoded
+  size: z.number().nonnegative()
+});
+var GetFileParamsSchema = z.object({
+  id: z.string().uuid()
+});
+var GetFileRequestSchema = GetFileParamsSchema;
+var GetFileResponseSchema = z.object({
+  id: z.string().uuid(),
+  key: z.string(),
+  filename: z.string(),
+  mimeType: z.string(),
+  size: z.number().nonnegative(),
+  checksum: z.string().optional(),
+  url: z.string().optional(),
+  publicUrl: z.string().optional(),
+  signedUrl: z.string().optional(),
+  bucket: z.string(),
+  entityType: z.string().optional(),
+  entityId: z.string().optional(),
+  category: z.string().optional(),
+  uploadedAt: z.string(),
+  expiresAt: z.string().optional()
+});
+var DownloadFileParamsSchema = z.object({
+  id: z.string().uuid()
+});
+var DownloadFileRequestSchema = DownloadFileParamsSchema;
+var DownloadFileResponseSchema = z.object({
+  buffer: z.string(),
+  // base64 encoded
+  size: z.number().nonnegative(),
+  mimeType: z.string(),
+  filename: z.string().optional()
+});
+var DeleteFileParamsSchema = z.object({
+  id: z.string().uuid()
+});
+var DeleteFileRequestSchema = DeleteFileParamsSchema;
+var DeleteFileResponseSchema = z.object({
+  success: z.boolean()
+});
+var GetSignedUrlParamsSchema = z.object({
+  id: z.string().uuid()
+});
+var GetSignedUrlQuerySchema = z.object({
+  expiresIn: z.number().positive().optional()
+});
+var GetSignedUrlRequestSchema = z.object({
+  /** File ID (UUID from media table) */
+  id: z.string().uuid(),
+  /** Optional query parameters */
+  query: GetSignedUrlQuerySchema.optional()
+});
+var GetSignedUrlResponseSchema = z.object({
+  url: z.string().url(),
+  expiresAt: z.string()
+});
 
 // src/errors/enums.ts
 var ERROR_SEVERITY = {
@@ -5639,6 +5839,6 @@ var ERROR_DEFINITIONS = {
   }
 };
 
-export { ALERT_SEVERITIES, ALERT_TYPES, ALL_EVENTS, API_ERROR_CODES, CACHE_DURATION_MS, CACHE_EVENTS, CHANGE_TYPES, CLIENT_EVENTS, CLIENT_HINT_HEADERS, COMMON_FIELDS, COMMON_OPERATIONS, COMMON_STORAGE_TYPES, CONFIG_EVENTS, COORDINATES, DATA_SAVER_PRESETS, DEBUGGER_CONFIG_SOURCES, DEBUG_EVENTS, DEFAULT_THRESHOLDS, ERROR_CATEGORY, ERROR_DEFINITIONS, ERROR_EVENTS, COMMON_FIELDS as ERROR_FIELDS, EVENTS_CONFIG_SOURCES, EVENT_CONSTANTS, EVENT_NAMESPACES, EVENT_OPERATIONS, EVENT_PRIORITY_MAP, EVENT_SCOPES, EVENT_SCOPES_WITH_TEMPORARY, FACTORY_OPERATIONS, HANDLER_SCOPES, HEADER_EVENTS, HEADER_STAGES, HISTORY_TYPES, IMPACT_LEVELS, INTERNAL_STATUS_CODES, NETWORK_CONFIDENCE_LEVELS, NETWORK_EVENTS, NETWORK_QUALITY, NetworkPresetNames, COMMON_OPERATIONS as OPERATIONS, INTERNAL_STATUS_CODES as PACKAGE_STATUS_CODES, PERFORMANCE_EVENTS, PRIORITY_LEVEL, PUB_SUB_EVENT, QUEUE_OPERATIONS, REGIONAL_CONFIDENCE_LEVELS, REGION_STORAGE_KEY, REGION_TO_PRESET, RTT_THRESHOLDS, SPEED_THRESHOLDS, COMMON_STORAGE_TYPES as STORAGE_TYPES, TRACKING_PHASES, UNIFIED_OPERATIONS, UPDATE_STRATEGIES, VALIDATION_RANGES, isValidConfigSource, isValidHistoryType, isValidOperation };
+export { ALERT_SEVERITIES, ALERT_TYPES, ALL_EVENTS, API_ERROR_CODES, AccessLevelSchema, CACHE_DURATION_MS, CACHE_EVENTS, CHANGE_TYPES, CLIENT_EVENTS, CLIENT_HINT_HEADERS, COMMON_FIELDS, COMMON_OPERATIONS, COMMON_STORAGE_TYPES, CONFIG_EVENTS, COORDINATES, DATA_SAVER_PRESETS, DEBUGGER_CONFIG_SOURCES, DEBUG_EVENTS, DEFAULT_THRESHOLDS, DeleteFileParamsSchema, DeleteFileRequestSchema, DeleteFileResponseSchema, DownloadFileParamsSchema, DownloadFileRequestSchema, DownloadFileResponseSchema, ERROR_CATEGORY, ERROR_DEFINITIONS, ERROR_EVENTS, COMMON_FIELDS as ERROR_FIELDS, EVENTS_CONFIG_SOURCES, EVENT_CONSTANTS, EVENT_NAMESPACES, EVENT_OPERATIONS, EVENT_PRIORITY_MAP, EVENT_SCOPES, EVENT_SCOPES_WITH_TEMPORARY, FACTORY_OPERATIONS, FileVariantSchema, GenerateDocumentRequestSchema, GenerateDocumentResponseSchema, GetFileParamsSchema, GetFileRequestSchema, GetFileResponseSchema, GetSignedUrlParamsSchema, GetSignedUrlQuerySchema, GetSignedUrlRequestSchema, GetSignedUrlResponseSchema, HANDLER_SCOPES, HEADER_EVENTS, HEADER_STAGES, HISTORY_TYPES, IMPACT_LEVELS, INTERNAL_STATUS_CODES, NETWORK_CONFIDENCE_LEVELS, NETWORK_EVENTS, NETWORK_QUALITY, NetworkPresetNames, COMMON_OPERATIONS as OPERATIONS, OutputFormatSchema, INTERNAL_STATUS_CODES as PACKAGE_STATUS_CODES, PERFORMANCE_EVENTS, PRIORITY_LEVEL, PUB_SUB_EVENT, PdfOptionsSchema, QUEUE_OPERATIONS, REGIONAL_CONFIDENCE_LEVELS, REGION_STORAGE_KEY, REGION_TO_PRESET, RTT_THRESHOLDS, SPEED_THRESHOLDS, COMMON_STORAGE_TYPES as STORAGE_TYPES, TRACKING_PHASES, UNIFIED_OPERATIONS, UPDATE_STRATEGIES, UploadFileItemSchema, UploadFileRequestSchema, UploadFileResponseSchema, UploadFileResultSchema, UploadFilesRequestSchema, UploadFilesResponseSchema, VALIDATION_RANGES, isValidConfigSource, isValidHistoryType, isValidOperation };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map