@christian-wechsel/image-assets 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Christian Wechsel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,127 @@
-# Temporary Holding Version
+# @christian-wechsel/image-assets
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript service for resizing, storing, caching, and retrieving image assets.
+
+`image-assets` orchestrates image handling for an application: it decides which device/scale variants of an image need to exist, resizes them via a pluggable `ImageResizer`, and persists them through a pluggable `ImageStorage` backend with an in-memory cache in front of it.
+
+---
+
+## Features
+
+- **Variant-based uploads**: Define a set of `DeviceImageType`s (e.g. `DESKTOP`/`MAIN`, `DESKTOP`/`PREVIEW`) and let `ImageAssetService` generate and store all required variants from a single uploaded image.
+- **Skip redundant work**: Before resizing, the service checks whether a variant already exists in storage and skips it if so.
+- **Pluggable storage**: `ImageStorage` is an abstract base class with built-in in-memory caching (reads and existence checks hit the cache first). Ships with a disk-based implementation (`ImageStorageDisk`); implement your own for GCS, S3, etc.
+- **Pluggable resizing**: `ImageResizer` delegates the actual resizing work to an HTTP service (see [Image Resizer prerequisite](#prerequisite-image-resizer-service) below).
+- **ESM / TypeScript**: Ships as compiled ESM with type declarations.
+
+---
+
+## Installation
+
+```shell
+npm install @christian-wechsel/image-assets
+```
+
+---
+
+## Prerequisite: Image Resizer Service
+
+`ImageAssetService` does not resize images itself. It delegates this work over HTTP to an `ImageResizer`, which expects a running service that exposes a `POST /resize` endpoint:
+
+- Request: `POST {url}/resize?width={width}&height={height}&format={png|jpeg}`, with header `Authorization: Bearer {apiKey}` and the raw image bytes as the request body.
+- Response: the resized image as binary data.
+
+You need to deploy such a service yourself, for example as a **Google Cloud Run** service. You can use [`image-resizer`](https://github.com/ChristianWechsel/image-resizer) for this — it implements exactly this contract using [`sharp`](https://www.npmjs.com/package/sharp).
+
+> **Note:** `image-resizer` is **not published on npm**. It is only available as source on GitHub: https://github.com/ChristianWechsel/image-resizer.git. Clone it, build it (`npm run build-prod`), and deploy it yourself (e.g. to Cloud Run) or implement a compatible service of your own.
+
+---
+
+## Usage
+
+```typescript
+import {
+  ImageAssetService,
+  ImageResizer,
+  ImageStorageDisk,
+  Cache,
+  type DeviceImageType,
+} from "@christian-wechsel/image-assets";
+
+// 1. Configure the resizer client (points at your deployed image-resizer service)
+const imageResizer = new ImageResizer({
+  url: "https://<your-image-resizer-cloud-run-url>",
+  apiKey: "<api-key>",
+});
+
+// 2. Configure a storage backend (disk is built-in; implement ImageStorage for others)
+const cache = new Cache<string, Buffer>();
+const imageStorage = new ImageStorageDisk(cache, "./uploads");
+
+// 3. Define the variants that should be generated for every uploaded image
+const imageTypes: DeviceImageType[] = [
+  { type: "DESKTOP", scale: "MAIN", format: "png" },
+  { type: "DESKTOP", scale: "PREVIEW", format: "png" },
+];
+
+const imageAssetService = new ImageAssetService(
+  imageResizer,
+  imageStorage,
+  imageTypes,
+);
+
+// Upload an image; missing variants are resized and stored automatically
+await imageAssetService.upload(imageBuffer, "photo.png");
+
+// Download a specific variant (served from cache if available)
+const { image, fileName } = await imageAssetService.download({
+  type: "DESKTOP",
+  scale: "MAIN",
+  format: "png",
+  filename: "photo.png",
+});
+```
+
+---
+
+## API
+
+| Export | Description |
+| :--- | :--- |
+| `ImageAssetService` | Orchestrates upload (resize + store missing variants) and download of image variants. |
+| `ImageResizer` | HTTP client that calls an external image resizing service (see [prerequisite](#prerequisite-image-resizer-service)). |
+| `ImageStorage` | Abstract base class for storage backends, with built-in caching. Extend it to support custom backends. |
+| `ImageStorageDisk` | File-system-based `ImageStorage` implementation. |
+| `Cache` | Simple in-memory key/value cache used in front of storage reads. |
+| `DeviceImageType`, `ImageParams`, `StoredImage` | Types describing image variants and stored results. |
+
+### Image variants
+
+Each variant is described by:
+
+- `type`: `"DESKTOP"` \| `"MOBILE"`
+- `scale`: `"ORIGINAL"` \| `"MAIN"` \| `"PREVIEW"`
+- `format`: `"png"` \| `"jpeg"`
+
+Currently, target dimensions are defined for `DESKTOP`/`MAIN` (688×384) and `DESKTOP`/`PREVIEW` (320×180). Other combinations are stored without resizing.
+
+### Implementing a custom `ImageStorage`
+
+Extend `ImageStorage` and implement the four protected hooks:
+
+```typescript
+class MyStorage extends ImageStorage {
+  protected uploadImageImpl(image: Buffer, params: ImageParams): Promise<void> { ... }
+  protected downloadImageImpl(params: ImageParams): Promise<StoredImage> { ... }
+  protected existsImpl(params: ImageParams): Promise<boolean> { ... }
+  protected listStorageContent(): Promise<ImageParams[]> { ... }
+}
+```
+
+`ImageStorage` takes care of caching reads/existence checks and writing through to the cache on upload.
+
+---
+
+## License
+
+[MIT](LICENSE)

package/ReadMe.development.md

@@ -0,0 +1,186 @@
+# TypeScript Library for Google Cloud & NPM
+
+A production-ready TypeScript library package pre-configured with strict TypeScript compilation, Jest testing (unit and integration), and automated CI/CD via Google Cloud Build and Terraform.
+
+---
+
+## Features
+
+- **Strict TypeScript**: Configured with modern ESM settings (`tsconfig.json`, `tsconfig.prod.json`, `tsconfig.test.json`).
+- **Jest Test Suites**: Split into fast unit tests (`*.test.unit.ts`) and integration tests (`*.test.int.ts`).
+- **Dual CI/CD Pipeline (`cloudbuild.yaml`)**:
+  - **Internal Releases**: Pushes to the target branch (e.g., `main`) automatically publish to your private **GCP Artifact Registry** NPM repository.
+  - **Public Releases**: Pushing a version tag (e.g., `v1.0.0`) automatically publishes to **npmjs.org** using a token from **GCP Secret Manager**.
+- **Infrastructure as Code (Terraform)**: Pre-configured Terraform code (`main.tf`, `variables.tf`) to manage Cloud Build triggers connected to your GitHub repository.
+
+---
+
+## Project Structure
+
+```text
+├── bin/
+│   └── clean.sh                 # Cleans dist/ build outputs
+├── src/
+│   ├── index.ts                 # Library entry point (public exports)
+│   ├── math/                    # Example domain module
+│   │   ├── add.ts               # Sample function
+│   │   ├── add.testdata.ts      # Test data fixtures
+│   │   └── add.test.unit.ts     # Unit test suite
+│   └── integration/             # Integration test directory
+│       └── add.test.int.ts      # Integration test suite
+├── cloudbuild.yaml              # Cloud Build pipeline configuration
+├── jest.config.mjs              # Jest configuration with project suites
+├── main.tf                      # Terraform Cloud Build triggers
+├── package.json                 # Package manifest, scripts, and dependencies
+├── provider.tf                  # Terraform Google provider config
+├── terraform.tfvars.example     # Example variable values for Terraform
+├── tsconfig.json                # Base TypeScript configuration
+├── tsconfig.prod.json           # Production build configuration
+├── tsconfig.test.json           # Test build configuration
+└── variables.tf                 # Terraform variable definitions
+```
+
+---
+
+## Getting Started
+
+### 1. Install Dependencies
+
+```shell
+npm install
+```
+
+### 2. Configure Package Metadata
+
+Open `package.json` and adjust:
+
+- `"name"`: Set your desired package name (e.g., `@your-scope/my-library`).
+- `"description"`: Brief summary of the library.
+- `"author"`: Your name and email.
+- `"repository"`: Git repository URL.
+
+Also update the [LICENSE](LICENSE) file with the current year and your name or organization.
+
+### 3. Setup GCP Cloud Build Triggers (Terraform)
+
+This repository includes Terraform configuration to create the Cloud Build triggers that run your CI/CD pipeline on branch pushes and tag releases.
+
+#### Prerequisite: Cloud Build 2nd Gen GitHub Connection
+
+For Cloud Build triggers to respond to Git push events, your GitHub account and repository must be connected to Google Cloud Build (2nd Gen). This connection must be authorized in GitHub:
+
+1. In **Google Cloud Console** > **Cloud Build** > **Repositories** (under **2nd gen**), click **Create host connection**.
+2. Follow the prompt to install and authorize the **Google Cloud Build GitHub App** on your GitHub account or organization.
+3. Click **Link repository** to connect your specific GitHub repository to this host connection.
+
+#### Provisioning the Triggers
+
+1. **Copy the example variables file:**
+
+   ```shell
+   cp terraform.tfvars.example terraform.tfvars
+   ```
+
+2. **Fill in your environment details in `terraform.tfvars`:**
+   - `project_id`: GCP Project ID.
+   - `location`: GCP region (e.g., `europe-west3`).
+   - `github_connection_name`: Name of the Cloud Build 2nd Gen host connection.
+   - `github_repo_name`: Name of the linked repository.
+   - `target_branch`: Git branch that triggers CI/CD builds on push (e.g., `main`).
+   - `account_id`: Service Account ID for Cloud Build.
+   - `gcp_repository_name`: Repository identifier in Cloud Build (`<github_owner>-<github_repo_name>`).
+   - `npm_scope`: NPM scope (e.g., `@my-org`).
+   - `npm_repository_id`: Artifact Registry repository ID for NPM packages.
+   - `npm_secret_name`: Secret Manager secret name for the NPM token.
+
+3. **Deploy the triggers:**
+
+   ```shell
+   terraform init
+   terraform apply
+   ```
+
+> **Note:** `terraform.tfvars` contains sensitive environment identifiers and is ignored by `.gitignore`. Do not commit this file.
+
+---
+
+## Local Development Scripts
+
+| Command | Description |
+| :--- | :--- |
+| `npm run build` | Compiles TypeScript using `tsconfig.json` into `dist/`. |
+| `npm run build-prod` | Produces a clean production build (`tsconfig.prod.json`). |
+| `npm test` | Builds test configuration and runs all unit and integration tests. |
+| `npm run test:unit` | Runs only unit tests (`*.test.unit.ts`). |
+| `npm run test:int` | Runs only integration tests (`*.test.int.ts`). |
+| `npm run clean` | Removes the `dist/` build directory. |
+
+---
+
+## CI/CD & Publishing Workflow
+
+The included [cloudbuild.yaml](cloudbuild.yaml) pipeline automates testing and deployment:
+
+### 1. Internal Branch Releases (GCP Artifact Registry)
+
+Every push to your target branch (`main`):
+
+1. Runs `npm audit --audit-level=high` for vulnerability scanning.
+2. Runs `npm ci` and `npm test` across all suites.
+3. Automatically authenticates using Cloud Build service account credentials.
+4. Publishes an internal package version to your private GCP Artifact Registry.
+
+### 2. Public Releases (npmjs.org)
+
+When you are ready to publish a release to public npm:
+
+1. Update the version in `package.json`:
+
+   ```shell
+   npm version patch # or minor, major
+   ```
+
+2. Push the commit and the version tag:
+
+   ```shell
+   git push origin main --tags
+   ```
+
+3. Cloud Build detects the `v*` tag, retrieves the `NPM_TOKEN` secret from Secret Manager, and publishes the package with public access:
+
+   ```shell
+   npm publish --access public
+   ```
+
+---
+
+## Consuming this Library
+
+### From GCP Artifact Registry (Internal)
+
+In downstream projects, configure `.npmrc`:
+
+```npmrc
+@your-scope:registry=https://<REGION>-npm.pkg.dev/<PROJECT_ID>/<REPOSITORY_ID>/
+```
+
+Authenticate your local environment:
+
+```shell
+npx google-artifactregistry-auth
+npm install @your-scope/my-library
+```
+
+### From npmjs.org (Public)
+
+```shell
+npm install @your-scope/my-library
+```
+
+---
+
+## License
+
+[MIT](LICENSE)
+
+> **Note:** Update the [LICENSE](LICENSE) file manually with the current year and your name or organization (replace `<YEAR>` and `<AUTHOR_OR_ORGANIZATION>`).

package/dist/cache/cache.d.ts

@@ -0,0 +1,7 @@
+export declare class Cache<KEY extends string | number, VALUE> {
+    private store;
+    get(key: KEY): VALUE | undefined;
+    set(key: KEY, value: VALUE): void;
+    has(key: KEY): boolean;
+}
+//# sourceMappingURL=cache.d.ts.map

package/dist/cache/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../src/cache/cache.ts"],"names":[],"mappings":"AAAA,qBAAa,KAAK,CAAC,GAAG,SAAS,MAAM,GAAG,MAAM,EAAE,KAAK;IACnD,OAAO,CAAC,KAAK,CAA8B;IAE3C,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,KAAK,GAAG,SAAS,CAE/B;IAED,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,GAAG,IAAI,CAEhC;IAED,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAErB;CACF"}

package/dist/cache/cache.js

@@ -0,0 +1,15 @@
+export class Cache {
+    constructor() {
+        this.store = new Map();
+    }
+    get(key) {
+        return this.store.get(key);
+    }
+    set(key, value) {
+        this.store.set(key, value);
+    }
+    has(key) {
+        return this.store.has(key);
+    }
+}
+//# sourceMappingURL=cache.js.map

package/dist/cache/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../src/cache/cache.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,KAAK;IAAlB;QACU,UAAK,GAAoB,IAAI,GAAG,EAAE,CAAC;IAa7C,CAAC;IAXC,GAAG,CAAC,GAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED,GAAG,CAAC,GAAQ,EAAE,KAAY;QACxB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAED,GAAG,CAAC,GAAQ;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;CACF"}

package/dist/image-resizer/image-resizer.d.ts

@@ -0,0 +1,16 @@
+export type ImageSizeProperties = {
+    width: number;
+    height: number;
+    format: "png" | "jpeg";
+};
+export declare class ImageResizer {
+    private options;
+    private readonly pathResize;
+    constructor(options: {
+        url: string;
+        apiKey: string;
+    });
+    resizeImage(image: BodyInit, options: ImageSizeProperties): Promise<Buffer>;
+    private getUrlWithParams;
+}
+//# sourceMappingURL=image-resizer.d.ts.map

package/dist/image-resizer/image-resizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-resizer.d.ts","sourceRoot":"","sources":["../../src/image-resizer/image-resizer.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB,CAAC;AAEF,qBAAa,YAAY;IAGX,OAAO,CAAC,OAAO;IAF3B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC,YAAoB,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAI;IAEhE,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,CAe1E;IAED,OAAO,CAAC,gBAAgB;CAOzB"}

package/dist/image-resizer/image-resizer.js

@@ -0,0 +1,30 @@
+export class ImageResizer {
+    constructor(options) {
+        this.options = options;
+        this.pathResize = "/resize";
+    }
+    resizeImage(image, options) {
+        return fetch(this.getUrlWithParams(this.pathResize, options), {
+            method: "POST",
+            headers: {
+                "Content-Type": "image/png",
+                Authorization: `Bearer ${this.options.apiKey}`,
+            },
+            body: image,
+        })
+            .then((response) => {
+            return response.arrayBuffer();
+        })
+            .then((arrayBuffer) => {
+            return Buffer.from(arrayBuffer);
+        });
+    }
+    getUrlWithParams(path, options) {
+        const url = new URL(path, this.options.url);
+        url.searchParams.append("width", options.width.toString());
+        url.searchParams.append("height", options.height.toString());
+        url.searchParams.append("format", options.format);
+        return url.toString();
+    }
+}
+//# sourceMappingURL=image-resizer.js.map

package/dist/image-resizer/image-resizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-resizer.js","sourceRoot":"","sources":["../../src/image-resizer/image-resizer.ts"],"names":[],"mappings":"AAMA,MAAM,OAAO,YAAY;IAGvB,YAAoB,OAAwC;QAAxC,YAAO,GAAP,OAAO,CAAiC;QAF3C,eAAU,GAAG,SAAS,CAAC;IAEuB,CAAC;IAEhE,WAAW,CAAC,KAAe,EAAE,OAA4B;QACvD,OAAO,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,EAAE;YAC5D,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,WAAW;gBAC3B,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;aAC/C;YACD,IAAI,EAAE,KAAK;SACZ,CAAC;aACC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjB,OAAO,QAAQ,CAAC,WAAW,EAAE,CAAC;QAChC,CAAC,CAAC;aACD,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;YACpB,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,gBAAgB,CAAC,IAAY,EAAE,OAA4B;QACjE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC5C,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3D,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC7D,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;CACF"}

package/dist/image-storage/image-storage-disk.d.ts

@@ -0,0 +1,16 @@
+import type { Cache } from "../cache/cache.js";
+import { type ImageParams, type StoredImage } from "../types/images.js";
+import { ImageStorage } from "./image-storage.js";
+export declare class ImageStorageDisk extends ImageStorage {
+    private folder;
+    constructor(cache: Cache<string, Buffer<ArrayBufferLike>>, folder: string);
+    protected uploadImageImpl(image: Buffer<ArrayBufferLike>, params: ImageParams): Promise<void>;
+    protected downloadImageImpl(params: ImageParams): Promise<StoredImage>;
+    protected listStorageContent(): Promise<ImageParams[]>;
+    protected existsImpl(params: ImageParams): Promise<boolean>;
+    private getFolderPath;
+    private createFolderIfNotExists;
+    private getImagePath;
+    private readDir;
+}
+//# sourceMappingURL=image-storage-disk.d.ts.map

package/dist/image-storage/image-storage-disk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-storage-disk.d.ts","sourceRoot":"","sources":["../../src/image-storage/image-storage-disk.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAIL,KAAK,WAAW,EAChB,KAAK,WAAW,EACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,qBAAa,gBAAiB,SAAQ,YAAY;IAG9C,OAAO,CAAC,MAAM;IAFhB,YACE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,EACrC,MAAM,EAAE,MAAM,EAIvB;IAED,SAAS,CAAC,eAAe,CACvB,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,EAC9B,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAKf;IAED,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAOrE;IAED,SAAS,CAAC,kBAAkB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAErD;IAED,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAI1D;IAED,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,uBAAuB;IAM/B,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,OAAO;CAgChB"}

package/dist/image-storage/image-storage-disk.js

@@ -0,0 +1,72 @@
+import { existsSync, lstatSync, mkdirSync, readdirSync } from "fs";
+import { readFile, writeFile } from "fs/promises";
+import { join } from "path";
+import { isImageParams, isImageScale, isImageType, } from "../types/images.js";
+import { ImageStorage } from "./image-storage.js";
+export class ImageStorageDisk extends ImageStorage {
+    constructor(cache, folder) {
+        super(cache);
+        this.folder = folder;
+        mkdirSync(this.folder, { recursive: true });
+    }
+    uploadImageImpl(image, params) {
+        const pathFolder = this.getFolderPath(params);
+        this.createFolderIfNotExists(pathFolder);
+        const pathImage = this.getImagePath(pathFolder, params.filename);
+        return writeFile(pathImage, image);
+    }
+    downloadImageImpl(params) {
+        const pathFolder = this.getFolderPath(params);
+        const pathImage = this.getImagePath(pathFolder, params.filename);
+        return readFile(pathImage).then((image) => ({
+            image,
+            fileName: params.filename,
+        }));
+    }
+    listStorageContent() {
+        return Promise.resolve(this.readDir(this.folder));
+    }
+    existsImpl(params) {
+        const pathFolder = this.getFolderPath(params);
+        const pathImage = this.getImagePath(pathFolder, params.filename);
+        return Promise.resolve(existsSync(pathImage));
+    }
+    getFolderPath(params) {
+        return join(this.folder, params.type, params.scale);
+    }
+    createFolderIfNotExists(path) {
+        if (!existsSync(path)) {
+            mkdirSync(path, { recursive: true });
+        }
+    }
+    getImagePath(folder, filename) {
+        return join(folder, filename);
+    }
+    readDir(path, parent = {}) {
+        const items = [];
+        const folderContent = readdirSync(path);
+        for (const item of folderContent) {
+            const itemPath = join(path, item);
+            const stat = lstatSync(itemPath);
+            const isDirectory = stat.isDirectory();
+            const isFile = stat.isFile();
+            if (isDirectory) {
+                if (isImageType(item)) {
+                    parent.type = item;
+                }
+                if (isImageScale(item)) {
+                    parent.scale = item;
+                }
+                items.push(...this.readDir(itemPath, { ...parent }));
+            }
+            if (isFile) {
+                parent.filename = item;
+                if (isImageParams(parent)) {
+                    items.push({ ...parent });
+                }
+            }
+        }
+        return items;
+    }
+}
+//# sourceMappingURL=image-storage-disk.js.map

package/dist/image-storage/image-storage-disk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-storage-disk.js","sourceRoot":"","sources":["../../src/image-storage/image-storage-disk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AACnE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,EACL,aAAa,EACb,YAAY,EACZ,WAAW,GAGZ,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD,YACE,KAA6C,EACrC,MAAc;QAEtB,KAAK,CAAC,KAAK,CAAC,CAAC;sBAFL,MAAM;QAGd,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,CAAC;IAES,eAAe,CACvB,KAA8B,EAC9B,MAAmB;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC9C,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;IAES,iBAAiB,CAAC,MAAmB;QAC7C,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC1C,KAAK;YACL,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC,CAAC,CAAC;IACN,CAAC;IAES,kBAAkB;QAC1B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAES,UAAU,CAAC,MAAmB;QACtC,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAChD,CAAC;IAEO,aAAa,CAAC,MAAmB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;IAEO,uBAAuB,CAAC,IAAY;QAC1C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,YAAY,CAAC,MAAc,EAAE,QAAgB;QACnD,OAAO,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAChC,CAAC;IAEO,OAAO,CACb,IAAY,EACZ,MAAM,GAAyB,EAAE;QAEjC,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAExC,KAAK,MAAM,IAAI,IAAI,aAAa,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAElC,MAAM,IAAI,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;YACjC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YAE7B,IAAI,WAAW,EAAE,CAAC;gBAChB,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACrB,CAAC;gBACD,IAAI,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;oBACvB,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;gBACtB,CAAC;gBACD,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC,CAAC;YACvD,CAAC;YACD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/dist/image-storage/image-storage.d.ts

@@ -0,0 +1,16 @@
+import type { Cache } from "../cache/cache.js";
+import { type ImageParams, type StoredImage } from "../types/images.js";
+export declare abstract class ImageStorage {
+    private cache;
+    constructor(cache: Cache<string, Buffer<ArrayBufferLike>>);
+    uploadImage(image: Buffer<ArrayBufferLike>, params: ImageParams): Promise<void>;
+    downloadImage(params: ImageParams): Promise<StoredImage>;
+    initCache(): Promise<void>;
+    exists(params: ImageParams): Promise<boolean>;
+    protected abstract uploadImageImpl(image: Buffer<ArrayBufferLike>, params: ImageParams): Promise<void>;
+    protected abstract downloadImageImpl(params: ImageParams): Promise<StoredImage>;
+    protected abstract existsImpl(params: ImageParams): Promise<boolean>;
+    protected abstract listStorageContent(): Promise<ImageParams[]>;
+    protected getPath(params: ImageParams): string;
+}
+//# sourceMappingURL=image-storage.d.ts.map

package/dist/image-storage/image-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-storage.d.ts","sourceRoot":"","sources":["../../src/image-storage/image-storage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAExE,8BAAsB,YAAY;IACpB,OAAO,CAAC,KAAK;IAAzB,YAAoB,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,EAAI;IAErE,WAAW,CACT,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,EAC9B,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAIf;IAED,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAUvD;IAED,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAMzB;IAED,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAK5C;IAED,SAAS,CAAC,QAAQ,CAAC,eAAe,CAChC,KAAK,EAAE,MAAM,CAAC,eAAe,CAAC,EAC9B,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAClC,MAAM,EAAE,WAAW,GAClB,OAAO,CAAC,WAAW,CAAC,CAAC;IAExB,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErE,SAAS,CAAC,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhE,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE7C;CACF"}

package/dist/image-storage/image-storage.js

@@ -0,0 +1,37 @@
+import {} from "../types/images.js";
+export class ImageStorage {
+    constructor(cache) {
+        this.cache = cache;
+    }
+    uploadImage(image, params) {
+        return this.uploadImageImpl(image, params).then(() => {
+            this.cache.set(this.getPath(params), image);
+        });
+    }
+    downloadImage(params) {
+        const path = this.getPath(params);
+        const cached = this.cache.get(path);
+        if (cached) {
+            return Promise.resolve({ image: cached, fileName: params.filename });
+        }
+        return this.downloadImageImpl(params).then((storedImage) => {
+            this.cache.set(path, storedImage.image);
+            return storedImage;
+        });
+    }
+    initCache() {
+        return this.listStorageContent().then((items) => {
+            return Promise.allSettled(items.map((item) => this.downloadImage(item))).then(() => { });
+        });
+    }
+    exists(params) {
+        if (this.cache.has(this.getPath(params))) {
+            return Promise.resolve(true);
+        }
+        return this.existsImpl(params);
+    }
+    getPath(params) {
+        return `/${params.type}/${params.scale}/${params.filename}`;
+    }
+}
+//# sourceMappingURL=image-storage.js.map

package/dist/image-storage/image-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-storage.js","sourceRoot":"","sources":["../../src/image-storage/image-storage.ts"],"names":[],"mappings":"AACA,OAAO,EAAsC,MAAM,oBAAoB,CAAC;AAExE,MAAM,OAAgB,YAAY;IAChC,YAAoB,KAA6C;qBAA7C,KAAK;IAA2C,CAAC;IAErE,WAAW,CACT,KAA8B,EAC9B,MAAmB;QAEnB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACnD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,MAAmB;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE;YACzD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;YACxC,OAAO,WAAW,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9C,OAAO,OAAO,CAAC,UAAU,CACvB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAC9C,CAAC,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAmB;QACxB,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACzC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAeS,OAAO,CAAC,MAAmB;QACnC,OAAO,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;IAC9D,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { ImageAssetService } from "./service/image-asset-service.js";
+//# 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,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { ImageAssetService } from "./service/image-asset-service.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/service/image-asset-service.d.ts

@@ -0,0 +1,14 @@
+import type { ImageResizer } from "../image-resizer/image-resizer.js";
+import type { ImageStorage } from "../image-storage/image-storage.js";
+import type { DeviceImageType, ImageParams, StoredImage } from "../types/images.js";
+export declare class ImageAssetService {
+    private imageResizer;
+    private imageStorage;
+    private readonly imageTypes;
+    constructor(imageResizer: ImageResizer, imageStorage: ImageStorage, imageTypes: DeviceImageType[]);
+    upload(image: Buffer, originalName: string): Promise<void>;
+    download(params: ImageParams): Promise<StoredImage>;
+    private factoryResizeImage;
+    private resizeImage;
+}
+//# sourceMappingURL=image-asset-service.d.ts.map

package/dist/service/image-asset-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-asset-service.d.ts","sourceRoot":"","sources":["../../src/service/image-asset-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAEb,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,KAAK,EACV,eAAe,EACf,WAAW,EACX,WAAW,EACZ,MAAM,oBAAoB,CAAC;AAE5B,qBAAa,iBAAiB;IAE1B,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAH7B,YACU,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EACjB,UAAU,EAAE,eAAe,EAAE,EAC5C;IAEJ,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAoCzD;IAED,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAElD;IAED,OAAO,CAAC,kBAAkB;IAiC1B,OAAO,CAAC,WAAW;CAMpB"}

package/dist/service/image-asset-service.js

@@ -0,0 +1,70 @@
+export class ImageAssetService {
+    constructor(imageResizer, imageStorage, imageTypes) {
+        this.imageResizer = imageResizer;
+        this.imageStorage = imageStorage;
+        this.imageTypes = imageTypes;
+    }
+    upload(image, originalName) {
+        return Promise.all(this.imageTypes
+            .map((imageType) => {
+            return {
+                imageParam: {
+                    ...imageType,
+                    filename: originalName,
+                },
+            };
+        })
+            .map(({ imageParam }) => {
+            return this.imageStorage.exists(imageParam).then((exists) => {
+                return { exists, imageParam };
+            });
+        }))
+            .then((exits) => {
+            return Promise.all(exits
+                .filter(({ exists }) => {
+                return !exists;
+            })
+                .map(({ imageParam }) => {
+                return this.factoryResizeImage(imageParam)(image).then((resizedImage) => {
+                    return this.imageStorage.uploadImage(resizedImage, imageParam);
+                });
+            }));
+        })
+            .then(() => { });
+    }
+    download(params) {
+        return this.imageStorage.downloadImage(params);
+    }
+    factoryResizeImage(params) {
+        let func = (image) => Promise.resolve(image);
+        if (params.type === "DESKTOP") {
+            switch (params.scale) {
+                case "MAIN":
+                    func = (image) => {
+                        return this.resizeImage(image, {
+                            width: 688,
+                            height: 384,
+                            format: params.format,
+                        });
+                    };
+                    break;
+                case "PREVIEW":
+                    func = (image) => {
+                        return this.resizeImage(image, {
+                            width: 320,
+                            height: 180,
+                            format: params.format,
+                        });
+                    };
+                    break;
+            }
+        }
+        else if (params.type === "MOBILE") {
+        }
+        return func;
+    }
+    resizeImage(image, options) {
+        return this.imageResizer.resizeImage(new Uint8Array(image), options);
+    }
+}
+//# sourceMappingURL=image-asset-service.js.map

package/dist/service/image-asset-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-asset-service.js","sourceRoot":"","sources":["../../src/service/image-asset-service.ts"],"names":[],"mappings":"AAWA,MAAM,OAAO,iBAAiB;IAC5B,YACU,YAA0B,EAC1B,YAA0B,EACjB,UAA6B;4BAFtC,YAAY;4BACZ,YAAY;0BACH,UAAU;IAC1B,CAAC;IAEJ,MAAM,CAAC,KAAa,EAAE,YAAoB;QACxC,OAAO,OAAO,CAAC,GAAG,CAChB,IAAI,CAAC,UAAU;aACZ,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;YACjB,OAAO;gBACL,UAAU,EAAE;oBACV,GAAG,SAAS;oBACZ,QAAQ,EAAE,YAAY;iBACvB;aACF,CAAC;QACJ,CAAC,CAAC;aACD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;YACtB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBAC1D,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CACL;aACE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,OAAO,OAAO,CAAC,GAAG,CAChB,KAAK;iBACF,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;gBACrB,OAAO,CAAC,MAAM,CAAC;YACjB,CAAC,CAAC;iBACD,GAAG,CAAC,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE;gBACtB,OAAO,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CACpD,CAAC,YAAY,EAAE,EAAE;oBACf,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAClC,YAAY,EACZ,UAAU,CACX,CAAC;gBACJ,CAAC,CACF,CAAC;YACJ,CAAC,CAAC,CACL,CAAC;QACJ,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;IACpB,CAAC;IAED,QAAQ,CAAC,MAAmB;QAC1B,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAEO,kBAAkB,CACxB,MAAmB;QAEnB,IAAI,IAAI,GAAuC,CAAC,KAAa,EAAE,EAAE,CAC/D,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAEzB,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,QAAQ,MAAM,CAAC,KAAK,EAAE,CAAC;gBACrB,KAAK,MAAM;oBACT,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;wBACvB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;4BAC7B,KAAK,EAAE,GAAG;4BACV,MAAM,EAAE,GAAG;4BACX,MAAM,EAAE,MAAM,CAAC,MAAM;yBACtB,CAAC,CAAC;oBACL,CAAC,CAAC;oBACF,MAAM;gBACR,KAAK,SAAS;oBACZ,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;wBACvB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;4BAC7B,KAAK,EAAE,GAAG;4BACV,MAAM,EAAE,GAAG;4BACX,MAAM,EAAE,MAAM,CAAC,MAAM;yBACtB,CAAC,CAAC;oBACL,CAAC,CAAC;oBACF,MAAM;YACV,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,WAAW,CACjB,KAAa,EACb,OAA4B;QAE5B,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}

package/dist/types/images.d.ts

@@ -0,0 +1,21 @@
+import type { ParsedPath } from "path";
+type ImageType = "DESKTOP" | "MOBILE";
+type ImageScale = "ORIGINAL" | "MAIN" | "PREVIEW";
+export type DeviceImageType = {
+    type: ImageType;
+    scale: ImageScale;
+    format: "png" | "jpeg";
+};
+export type ImageStorageOptions = ParsedPath & DeviceImageType;
+export declare function isImageType(value: any): value is ImageType;
+export declare function isImageScale(value: any): value is ImageScale;
+export type ImageParams = DeviceImageType & {
+    filename: string;
+};
+export declare function isImageParams(obj: any): obj is ImageParams;
+export type StoredImage = {
+    image: Buffer;
+    fileName: string;
+};
+export {};
+//# sourceMappingURL=images.d.ts.map

package/dist/types/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../src/types/images.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAEvC,KAAK,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;AACtC,KAAK,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAElD,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;IAClB,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,eAAe,CAAC;AAE/D,wBAAgB,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,SAAS,CAE1D;AACD,wBAAgB,YAAY,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAE5D;AAED,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG;IAC1C,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,wBAAgB,aAAa,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,WAAW,CAQ1D;AAED,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/types/images.js

@@ -0,0 +1,14 @@
+export function isImageType(value) {
+    return value === "DESKTOP" || value === "MOBILE";
+}
+export function isImageScale(value) {
+    return value === "ORIGINAL" || value === "MAIN" || value === "PREVIEW";
+}
+export function isImageParams(obj) {
+    return (obj &&
+        typeof obj.filename === "string" &&
+        obj.filename.length < 255 &&
+        isImageType(obj.type) &&
+        isImageScale(obj.scale));
+}
+//# sourceMappingURL=images.js.map

package/dist/types/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../../src/types/images.ts"],"names":[],"mappings":"AAaA,MAAM,UAAU,WAAW,CAAC,KAAU;IACpC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,QAAQ,CAAC;AACnD,CAAC;AACD,MAAM,UAAU,YAAY,CAAC,KAAU;IACrC,OAAO,KAAK,KAAK,UAAU,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,SAAS,CAAC;AACzE,CAAC;AAMD,MAAM,UAAU,aAAa,CAAC,GAAQ;IACpC,OAAO,CACL,GAAG;QACH,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAChC,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,GAAG;QACzB,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC;QACrB,YAAY,CAAC,GAAG,CAAC,KAAK,CAAC,CACxB,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@christian-wechsel/image-assets",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "TypeScript service for resizing, storing, caching, and retrieving image assets.",
+  "main": "dist/index.js",
+  "scripts": {
+    "test": "npm run build-test && jest",
+    "clean": "./bin/clean.sh",
+    "prebuild": "npm run clean",
+    "build": "tsc --project tsconfig.json",
+    "prebuild-test": "npm run clean",
+    "build-test": "tsc --project tsconfig.test.json",
+    "prebuild-prod": "npm run clean",
+    "build-prod": "tsc --project tsconfig.prod.json",
+    "prepublishOnly": "npm run build-prod",
+    "test:unit": "set NODE_ENV=test && npm run build-test && jest --selectProjects Unit",
+    "test:int": "set NODE_ENV=test && npm run build-test && jest --selectProjects Integration",
+    "debug": "node --inspect-brk dist/index.js",
+    "start": "node dist/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ChristianWechsel/image-assets.git"
+  },
+  "keywords": [
+    "image",
+    "images",
+    "image-assets",
+    "image-resizing",
+    "image-storage",
+    "asset-management",
+    "typescript"
+  ],
+  "author": "Christian Wechsel <npm@christian-wechsel.com>",
+  "license": "MIT",
+  "type": "module",
+  "bugs": {
+    "url": "https://github.com/ChristianWechsel/image-assets/issues"
+  },
+  "homepage": "https://github.com/ChristianWechsel/image-assets#readme",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^26.6.6",
+    "jest": "^30.5.2",
+    "typescript": "^7.0.2"
+  }
+}