@platecms/delta-types 1.12.0 → 1.13.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platecms/delta-types",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "This package contains various utility types.",
   "license": "UNLICENSED",
   "publishConfig": {
@@ -17,8 +17,8 @@
     "src/**/*"
   ],
   "peerDependencies": {
-    "@platecms/delta-cast": "1.12.0",
-    "@platecms/delta-plate-resource-notation": "1.12.0",
+    "@platecms/delta-cast": "1.13.0",
+    "@platecms/delta-plate-resource-notation": "1.13.0",
     "class-transformer": "0.5.1",
     "reflect-metadata": "0.2.2",
     "tslib": "2.8.1"

package/src/index.ts

@@ -5,3 +5,4 @@ export * from "./lib/primitive.type";
 export * from "./lib/stage.enum";
 export * from "./lib/header-keys.enum";
 export * from "./lib/action-type.enum";
+export * from "./lib/processed-asset-options.interface";

package/src/lib/processed-asset-options.interface.ts

@@ -0,0 +1,60 @@
+/**
+ * Options for generating a processed (e.g. resized, reformatted) version of an asset URL.
+ */
+export interface ProcessedAssetOptions {
+  readonly width?: number | null;
+  readonly height?: number | null;
+  readonly quality?: number | null;
+  readonly resizingType?: string | null;
+  readonly format?: string | null;
+  readonly dpr?: number | null;
+}
+
+// Default presets.
+const PRESET_2XL_WEBP: ProcessedAssetOptions = { width: 3840, height: 2160, format: "webp" };
+const PRESET_XL_WEBP: ProcessedAssetOptions = { width: 2560, height: 1400, format: "webp" };
+const PRESET_LG_WEBP: ProcessedAssetOptions = { width: 1920, height: 1080, format: "webp" };
+const PRESET_MD_WEBP: ProcessedAssetOptions = { width: 1280, height: 720, format: "webp" };
+const PRESET_SM_WEBP: ProcessedAssetOptions = { width: 800, height: 450, format: "webp" };
+const PRESET_XS_WEBP: ProcessedAssetOptions = { width: 400, height: 150, format: "webp" };
+const PRESET_2XS_WEBP: ProcessedAssetOptions = { width: 200, height: 150, format: "webp" };
+
+const PRESET_ICON_WEBP: ProcessedAssetOptions = { width: 32, height: 32, format: "webp" };
+const PRESET_THUMBNAIL_WEBP: ProcessedAssetOptions = { width: 300, height: 300, format: "webp" };
+
+const PRESET_2XL: ProcessedAssetOptions = { width: 3840, height: 2160 };
+const PRESET_XL: ProcessedAssetOptions = { width: 2560, height: 1400 };
+const PRESET_LG: ProcessedAssetOptions = { width: 1920, height: 1080 };
+const PRESET_MD: ProcessedAssetOptions = { width: 1280, height: 720 };
+const PRESET_SM: ProcessedAssetOptions = { width: 800, height: 450 };
+const PRESET_XS: ProcessedAssetOptions = { width: 400, height: 150 };
+const PRESET_2XS: ProcessedAssetOptions = { width: 200, height: 150 };
+
+const PRESET_ICON: ProcessedAssetOptions = { width: 32, height: 32 };
+const PRESET_THUMBNAIL: ProcessedAssetOptions = { width: 300, height: 300 };
+
+/**
+ * Default image sizes preset for exposing assets.
+ * Order matters. Do not reorder, only append.
+ */
+export const DEFAULT_IMAGE_SIZES_PRESET: readonly ProcessedAssetOptions[] = [
+  PRESET_2XL_WEBP,
+  PRESET_XL_WEBP,
+  PRESET_LG_WEBP,
+  PRESET_MD_WEBP,
+  PRESET_SM_WEBP,
+  PRESET_XS_WEBP,
+  PRESET_2XS_WEBP,
+  PRESET_ICON_WEBP,
+  PRESET_THUMBNAIL_WEBP,
+
+  PRESET_2XL,
+  PRESET_XL,
+  PRESET_LG,
+  PRESET_MD,
+  PRESET_SM,
+  PRESET_XS,
+  PRESET_2XS,
+  PRESET_ICON,
+  PRESET_THUMBNAIL,
+];