@cibule/image 0.1.1

package/README.md

@@ -0,0 +1,99 @@
+# @cibule/image
+
+Image transformation core package. Defines the `ImageTransformer` abstract class, transform options, and configuration constants used by driver packages (`@cibule/image-sharp`, `@cibule/image-cf`).
+
+## Installation
+
+```bash
+npm install @cibule/image
+```
+
+## API
+
+### ImageTransformer
+
+Abstract class defining the image transformation contract:
+
+```typescript
+import { ImageTransformer } from '@cibule/image';
+
+abstract class ImageTransformer {
+  abstract transform(key: string, options: TransformOptions): Promise<TransformResult>;
+  abstract purgeCache(): Promise<PurgeCacheResult>;
+}
+```
+
+### TransformOptions
+
+Options passed to `transform()`:
+
+```typescript
+interface TransformOptions {
+  readonly width: number;
+  readonly quality?: number; // default: 80
+  readonly format?: ImageFormat; // 'avif' | 'webp' | 'jpeg' | 'png'
+  readonly fit?: ImageFit; // 'cover' | 'contain' | 'fill' | 'inside' | 'outside'
+}
+```
+
+### TransformResult
+
+Result returned by `transform()`:
+
+```typescript
+interface TransformResult {
+  readonly body: ReadableStream<Uint8Array>;
+  readonly contentType: string;
+  readonly width: number;
+  readonly height: number;
+  readonly size: number;
+}
+```
+
+### PurgeCacheResult
+
+Result returned by `purgeCache()`:
+
+```typescript
+interface PurgeCacheResult {
+  readonly purgedCount: number;
+}
+```
+
+### DI Token
+
+Injection token for the accessor pattern:
+
+```typescript
+import { IMAGE_TRANSFORMER_ACCESSOR } from '@cibule/image';
+import type { ImageTransformerAccessor } from '@cibule/image';
+
+// Register
+const providers = [{ provide: IMAGE_TRANSFORMER_ACCESSOR, useFactory: () => () => myTransformer }];
+
+// Resolve
+const getTransformer = inject(IMAGE_TRANSFORMER_ACCESSOR);
+const transformer = getTransformer();
+```
+
+### Constants
+
+```typescript
+import {
+  ALLOWED_WIDTHS, // [384, 640, 750, 828, 1080, 1200, 1920]
+  ALLOWED_PLACEHOLDER_WIDTHS, // [20, 30, 50, 80]
+  DEFAULT_QUALITY, // 80
+  DEFAULT_MAX_SOURCE_SIZE, // 62914560 (60 MB)
+} from '@cibule/image';
+```
+
+## Drivers
+
+| Package               | Strategy                       | Cache                              |
+| --------------------- | ------------------------------ | ---------------------------------- |
+| `@cibule/image-sharp` | Sharp library, resize + AVIF   | Local FileStorage (`/thumbnails/`) |
+| `@cibule/image-cf`    | CF Image Resizing (`cf.image`) | CDN edge (purge via CF API)        |
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,75 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ALLOWED_PLACEHOLDER_WIDTHS: () => ALLOWED_PLACEHOLDER_WIDTHS,
+  ALLOWED_WIDTHS: () => ALLOWED_WIDTHS,
+  DEFAULT_MAX_SOURCE_SIZE: () => DEFAULT_MAX_SOURCE_SIZE,
+  DEFAULT_QUALITY: () => DEFAULT_QUALITY,
+  IMAGE_TRANSFORMER_ACCESSOR: () => IMAGE_TRANSFORMER_ACCESSOR,
+  ImageTransformer: () => ImageTransformer,
+  getContentType: () => getContentType
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/lib/constants.ts
+var ALLOWED_WIDTHS = [384, 640, 750, 828, 1080, 1200, 1920];
+var ALLOWED_PLACEHOLDER_WIDTHS = [20, 30, 50, 80];
+var DEFAULT_QUALITY = 80;
+var DEFAULT_MAX_SOURCE_SIZE = 60 * 1024 * 1024;
+
+// src/lib/content-type-map.ts
+var FORMAT_TO_CONTENT_TYPE = {
+  avif: "image/avif",
+  webp: "image/webp",
+  jpeg: "image/jpeg",
+  png: "image/png"
+};
+function getContentType(format) {
+  return FORMAT_TO_CONTENT_TYPE[format];
+}
+
+// src/lib/image-transformer.ts
+var ImageTransformer = class {
+};
+
+// ../di/src/lib/injection-token.ts
+var InjectionToken = class {
+  constructor(description) {
+    this.description = description;
+  }
+};
+
+// src/lib/image-transformer-accessor.ts
+var IMAGE_TRANSFORMER_ACCESSOR = new InjectionToken(
+  "IMAGE_TRANSFORMER_ACCESSOR"
+);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ALLOWED_PLACEHOLDER_WIDTHS,
+  ALLOWED_WIDTHS,
+  DEFAULT_MAX_SOURCE_SIZE,
+  DEFAULT_QUALITY,
+  IMAGE_TRANSFORMER_ACCESSOR,
+  ImageTransformer,
+  getContentType
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/index.ts", "../src/lib/constants.ts", "../src/lib/content-type-map.ts", "../src/lib/image-transformer.ts", "../../di/src/lib/injection-token.ts", "../src/lib/image-transformer-accessor.ts"],
+  "sourcesContent": ["export {\n  ALLOWED_PLACEHOLDER_WIDTHS,\n  ALLOWED_WIDTHS,\n  DEFAULT_MAX_SOURCE_SIZE,\n  DEFAULT_QUALITY,\n} from './lib/constants';\nexport { getContentType } from './lib/content-type-map';\nexport { ImageTransformer } from './lib/image-transformer';\nexport type { ImageTransformerAccessor } from './lib/image-transformer-accessor';\nexport { IMAGE_TRANSFORMER_ACCESSOR } from './lib/image-transformer-accessor';\nexport type {\n  ImageFit,\n  ImageFormat,\n  PurgeCacheResult,\n  TransformOptions,\n  TransformResult,\n} from './lib/transform-options';\n", "export const ALLOWED_WIDTHS = [384, 640, 750, 828, 1080, 1200, 1920] as const;\n\nexport const ALLOWED_PLACEHOLDER_WIDTHS = [20, 30, 50, 80] as const;\n\nexport const DEFAULT_QUALITY = 80;\n\nexport const DEFAULT_MAX_SOURCE_SIZE = 60 * 1024 * 1024;\n", "import type { ImageFormat } from './transform-options';\n\nconst FORMAT_TO_CONTENT_TYPE: Record<ImageFormat, string> = {\n  avif: 'image/avif',\n  webp: 'image/webp',\n  jpeg: 'image/jpeg',\n  png: 'image/png',\n};\n\nexport function getContentType(format: ImageFormat): string {\n  return FORMAT_TO_CONTENT_TYPE[format];\n}\n", "import type { PurgeCacheResult, TransformOptions, TransformResult } from './transform-options';\n\nexport abstract class ImageTransformer {\n  abstract transform(key: string, options: TransformOptions): Promise<TransformResult>;\n  abstract purgeCache(): Promise<PurgeCacheResult>;\n}\n", "export class InjectionToken<T> {\n  declare readonly _brand: T;\n  constructor(public readonly description: string) {}\n}\n", "import { InjectionToken } from '@cibule/di';\n\nimport type { ImageTransformer } from './image-transformer';\n\nexport type ImageTransformerAccessor = () => ImageTransformer;\n\nexport const IMAGE_TRANSFORMER_ACCESSOR = new InjectionToken<ImageTransformerAccessor>(\n  'IMAGE_TRANSFORMER_ACCESSOR',\n);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAM,iBAAiB,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,MAAM,IAAI;AAE5D,IAAM,6BAA6B,CAAC,IAAI,IAAI,IAAI,EAAE;AAElD,IAAM,kBAAkB;AAExB,IAAM,0BAA0B,KAAK,OAAO;;;ACJnD,IAAM,yBAAsD;AAAA,EAC1D,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,KAAK;AACP;AAEO,SAAS,eAAe,QAA6B;AAC1D,SAAO,uBAAuB,MAAM;AACtC;;;ACTO,IAAe,mBAAf,MAAgC;AAGvC;;;ACLO,IAAM,iBAAN,MAAwB;AAAA,EAE7B,YAA4B,aAAqB;AAArB;AAAA,EAAsB;AACpD;;;ACGO,IAAM,6BAA6B,IAAI;AAAA,EAC5C;AACF;",
+  "names": []
+}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { ALLOWED_PLACEHOLDER_WIDTHS, ALLOWED_WIDTHS, DEFAULT_MAX_SOURCE_SIZE, DEFAULT_QUALITY, } from './lib/constants';
+export { getContentType } from './lib/content-type-map';
+export { ImageTransformer } from './lib/image-transformer';
+export type { ImageTransformerAccessor } from './lib/image-transformer-accessor';
+export { IMAGE_TRANSFORMER_ACCESSOR } from './lib/image-transformer-accessor';
+export type { ImageFit, ImageFormat, PurgeCacheResult, TransformOptions, TransformResult, } from './lib/transform-options';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,0BAA0B,EAC1B,cAAc,EACd,uBAAuB,EACvB,eAAe,GAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,YAAY,EACV,QAAQ,EACR,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,GAChB,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1,42 @@
+// src/lib/constants.ts
+var ALLOWED_WIDTHS = [384, 640, 750, 828, 1080, 1200, 1920];
+var ALLOWED_PLACEHOLDER_WIDTHS = [20, 30, 50, 80];
+var DEFAULT_QUALITY = 80;
+var DEFAULT_MAX_SOURCE_SIZE = 60 * 1024 * 1024;
+
+// src/lib/content-type-map.ts
+var FORMAT_TO_CONTENT_TYPE = {
+  avif: "image/avif",
+  webp: "image/webp",
+  jpeg: "image/jpeg",
+  png: "image/png"
+};
+function getContentType(format) {
+  return FORMAT_TO_CONTENT_TYPE[format];
+}
+
+// src/lib/image-transformer.ts
+var ImageTransformer = class {
+};
+
+// ../di/src/lib/injection-token.ts
+var InjectionToken = class {
+  constructor(description) {
+    this.description = description;
+  }
+};
+
+// src/lib/image-transformer-accessor.ts
+var IMAGE_TRANSFORMER_ACCESSOR = new InjectionToken(
+  "IMAGE_TRANSFORMER_ACCESSOR"
+);
+export {
+  ALLOWED_PLACEHOLDER_WIDTHS,
+  ALLOWED_WIDTHS,
+  DEFAULT_MAX_SOURCE_SIZE,
+  DEFAULT_QUALITY,
+  IMAGE_TRANSFORMER_ACCESSOR,
+  ImageTransformer,
+  getContentType
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/lib/constants.ts", "../src/lib/content-type-map.ts", "../src/lib/image-transformer.ts", "../../di/src/lib/injection-token.ts", "../src/lib/image-transformer-accessor.ts"],
+  "sourcesContent": ["export const ALLOWED_WIDTHS = [384, 640, 750, 828, 1080, 1200, 1920] as const;\n\nexport const ALLOWED_PLACEHOLDER_WIDTHS = [20, 30, 50, 80] as const;\n\nexport const DEFAULT_QUALITY = 80;\n\nexport const DEFAULT_MAX_SOURCE_SIZE = 60 * 1024 * 1024;\n", "import type { ImageFormat } from './transform-options';\n\nconst FORMAT_TO_CONTENT_TYPE: Record<ImageFormat, string> = {\n  avif: 'image/avif',\n  webp: 'image/webp',\n  jpeg: 'image/jpeg',\n  png: 'image/png',\n};\n\nexport function getContentType(format: ImageFormat): string {\n  return FORMAT_TO_CONTENT_TYPE[format];\n}\n", "import type { PurgeCacheResult, TransformOptions, TransformResult } from './transform-options';\n\nexport abstract class ImageTransformer {\n  abstract transform(key: string, options: TransformOptions): Promise<TransformResult>;\n  abstract purgeCache(): Promise<PurgeCacheResult>;\n}\n", "export class InjectionToken<T> {\n  declare readonly _brand: T;\n  constructor(public readonly description: string) {}\n}\n", "import { InjectionToken } from '@cibule/di';\n\nimport type { ImageTransformer } from './image-transformer';\n\nexport type ImageTransformerAccessor = () => ImageTransformer;\n\nexport const IMAGE_TRANSFORMER_ACCESSOR = new InjectionToken<ImageTransformerAccessor>(\n  'IMAGE_TRANSFORMER_ACCESSOR',\n);\n"],
+  "mappings": ";AAAO,IAAM,iBAAiB,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,MAAM,IAAI;AAE5D,IAAM,6BAA6B,CAAC,IAAI,IAAI,IAAI,EAAE;AAElD,IAAM,kBAAkB;AAExB,IAAM,0BAA0B,KAAK,OAAO;;;ACJnD,IAAM,yBAAsD;AAAA,EAC1D,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AAAA,EACN,KAAK;AACP;AAEO,SAAS,eAAe,QAA6B;AAC1D,SAAO,uBAAuB,MAAM;AACtC;;;ACTO,IAAe,mBAAf,MAAgC;AAGvC;;;ACLO,IAAM,iBAAN,MAAwB;AAAA,EAE7B,YAA4B,aAAqB;AAArB;AAAA,EAAsB;AACpD;;;ACGO,IAAM,6BAA6B,IAAI;AAAA,EAC5C;AACF;",
+  "names": []
+}

package/dist/lib/constants.d.ts

@@ -0,0 +1,5 @@
+export declare const ALLOWED_WIDTHS: readonly [384, 640, 750, 828, 1080, 1200, 1920];
+export declare const ALLOWED_PLACEHOLDER_WIDTHS: readonly [20, 30, 50, 80];
+export declare const DEFAULT_QUALITY = 80;
+export declare const DEFAULT_MAX_SOURCE_SIZE: number;
+//# sourceMappingURL=constants.d.ts.map

package/dist/lib/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,iDAAkD,CAAC;AAE9E,eAAO,MAAM,0BAA0B,2BAA4B,CAAC;AAEpE,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC,eAAO,MAAM,uBAAuB,QAAmB,CAAC"}

package/dist/lib/content-type-map.d.ts

@@ -0,0 +1,3 @@
+import type { ImageFormat } from './transform-options';
+export declare function getContentType(format: ImageFormat): string;
+//# sourceMappingURL=content-type-map.d.ts.map

package/dist/lib/content-type-map.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-type-map.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/content-type-map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AASvD,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE1D"}

package/dist/lib/image-transformer-accessor.d.ts

@@ -0,0 +1,5 @@
+import { InjectionToken } from '@cibule/di';
+import type { ImageTransformer } from './image-transformer';
+export type ImageTransformerAccessor = () => ImageTransformer;
+export declare const IMAGE_TRANSFORMER_ACCESSOR: InjectionToken<ImageTransformerAccessor>;
+//# sourceMappingURL=image-transformer-accessor.d.ts.map

package/dist/lib/image-transformer-accessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-transformer-accessor.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/image-transformer-accessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,MAAM,MAAM,wBAAwB,GAAG,MAAM,gBAAgB,CAAC;AAE9D,eAAO,MAAM,0BAA0B,0CAEtC,CAAC"}

package/dist/lib/image-transformer.d.ts

@@ -0,0 +1,6 @@
+import type { PurgeCacheResult, TransformOptions, TransformResult } from './transform-options';
+export declare abstract class ImageTransformer {
+    abstract transform(key: string, options: TransformOptions): Promise<TransformResult>;
+    abstract purgeCache(): Promise<PurgeCacheResult>;
+}
+//# sourceMappingURL=image-transformer.d.ts.map

package/dist/lib/image-transformer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-transformer.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/image-transformer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE/F,8BAAsB,gBAAgB;IACpC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IACpF,QAAQ,CAAC,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;CACjD"}

package/dist/lib/transform-options.d.ts

@@ -0,0 +1,19 @@
+export type ImageFormat = 'avif' | 'webp' | 'jpeg' | 'png';
+export type ImageFit = 'cover' | 'contain' | 'fill' | 'inside' | 'outside';
+export interface TransformOptions {
+    readonly width: number;
+    readonly quality?: number;
+    readonly format?: ImageFormat;
+    readonly fit?: ImageFit;
+}
+export interface TransformResult {
+    readonly body: ReadableStream<Uint8Array>;
+    readonly contentType: string;
+    readonly width: number;
+    readonly height: number;
+    readonly size: number;
+}
+export interface PurgeCacheResult {
+    readonly purgedCount: number;
+}
+//# sourceMappingURL=transform-options.d.ts.map

package/dist/lib/transform-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transform-options.d.ts","sourceRoot":"","sources":["../../../../../../src/lib/transform-options.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE3D,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE3E,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC;CACzB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IAC1C,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@cibule/image",
+  "version": "0.1.1",
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/LadaBr/cibule",
+    "directory": "packages/image"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@cibule/di": "workspace:*"
+  }
+}