@sokol111/ecommerce-image-service-api 1.0.27 → 1.0.28

package/dist/api.schemas.d.ts

@@ -0,0 +1,277 @@
+/**
+ * Generated by orval v7.13.2 🍺
+ * Do not edit manually.
+ * Image Service API
+ * API for managing images
+ * OpenAPI spec version: 1.0.28
+ */
+export type OwnerType = typeof OwnerType[keyof typeof OwnerType];
+export declare const OwnerType: {
+    readonly productDraft: "productDraft";
+    readonly product: "product";
+    readonly user: "user";
+};
+export type ImageRole = typeof ImageRole[keyof typeof ImageRole];
+export declare const ImageRole: {
+    readonly main: "main";
+    readonly gallery: "gallery";
+    readonly other: "other";
+};
+export type ImageStatus = typeof ImageStatus[keyof typeof ImageStatus];
+export declare const ImageStatus: {
+    readonly pending: "pending";
+    readonly uploaded: "uploaded";
+    readonly processing: "processing";
+    readonly ready: "ready";
+    readonly failed: "failed";
+    readonly deleted: "deleted";
+};
+export interface Variant {
+    name?: string;
+    /** S3 key of the variant */
+    key?: string;
+    width?: number;
+    height?: number;
+    mime?: string;
+    size?: number;
+}
+export interface Image {
+    id: string;
+    ownerType: OwnerType;
+    ownerId: string;
+    role: ImageRole;
+    /** S3 key of the original image */
+    key: string;
+    /**
+     * Optional — direct URL if public or via proxy
+     * @nullable
+     */
+    url?: string | null;
+    alt: string;
+    mime: string;
+    size: number;
+    /** @nullable */
+    hash?: string | null;
+    status: ImageStatus;
+    variants?: Variant[];
+    createdAt: string;
+    modifiedAt: string;
+}
+export interface ImagePatch {
+    alt?: string;
+    role?: ImageRole;
+    /** Position in the product gallery */
+    order?: number;
+}
+export type PresignRequestContentType = typeof PresignRequestContentType[keyof typeof PresignRequestContentType];
+export declare const PresignRequestContentType: {
+    readonly 'image/jpeg': "image/jpeg";
+    readonly 'image/png': "image/png";
+    readonly 'image/webp': "image/webp";
+    readonly 'image/avif': "image/avif";
+};
+export interface PresignRequest {
+    ownerType: OwnerType;
+    /**
+     * Draft ID or owner ID
+     * @minLength 1
+     */
+    ownerId: string;
+    /** @minLength 1 */
+    filename: string;
+    contentType: PresignRequestContentType;
+    /**
+     * Size in bytes
+     * @minimum 1
+     * @maximum 10485760
+     */
+    size: number;
+    role: ImageRole;
+}
+export type PresignResponseRequiredHeaders = {
+    [key: string]: string;
+};
+export interface PresignResponse {
+    uploadUrl: string;
+    /** Signed JWT token containing upload metadata (key, ownerType, ownerId, role, etc.) */
+    uploadToken: string;
+    /** TTL in seconds */
+    expiresIn: number;
+    requiredHeaders: PresignResponseRequiredHeaders;
+}
+export interface ConfirmRequest {
+    /**
+     * Signed JWT token from presign response
+     * @minLength 1
+     */
+    uploadToken: string;
+    alt: string;
+    role: ImageRole;
+    /**
+     * e.g., SHA256 hex for additional integrity check
+     * @nullable
+     */
+    checksum?: string | null;
+}
+export interface PromoteRequest {
+    /** @minLength 1 */
+    draftId: string;
+    /** @minLength 1 */
+    productId: string;
+    /** If true — copy to products/{productId}/... and remove old objects */
+    move: boolean;
+    /** If omitted — promote all images of the draft */
+    images?: string[];
+}
+export type BatchUrlRequestFit = typeof BatchUrlRequestFit[keyof typeof BatchUrlRequestFit];
+export declare const BatchUrlRequestFit: {
+    readonly cover: "cover";
+    readonly contain: "contain";
+    readonly fill: "fill";
+    readonly inside: "inside";
+    readonly outside: "outside";
+};
+export type BatchUrlRequestFormat = typeof BatchUrlRequestFormat[keyof typeof BatchUrlRequestFormat];
+export declare const BatchUrlRequestFormat: {
+    readonly original: "original";
+    readonly webp: "webp";
+    readonly avif: "avif";
+    readonly jpeg: "jpeg";
+    readonly png: "png";
+};
+export interface BatchUrlRequest {
+    /**
+     * List of image IDs to get URLs for (max 50)
+     * @minItems 1
+     * @maxItems 50
+     */
+    imageIds: string[];
+    /**
+     * Width in pixels
+     * @minimum 1
+     */
+    w?: number;
+    /**
+     * Height in pixels
+     * @minimum 1
+     */
+    h?: number;
+    fit?: BatchUrlRequestFit;
+    format?: BatchUrlRequestFormat;
+    /**
+     * @minimum 1
+     * @maximum 100
+     */
+    quality?: number;
+}
+export interface BatchUrlResponse {
+    urls: ImageUrl[];
+    /** Image IDs that were not found */
+    notFound?: string[];
+}
+export interface ImageUrl {
+    imageId: string;
+    url: string;
+    expiresAt?: string;
+}
+export type ProblemErrorsItem = {
+    field?: string;
+    message?: string;
+};
+/**
+ * RFC7807 Problem Details
+ */
+export interface Problem {
+    type: string;
+    title: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    traceId?: string;
+    errors?: ProblemErrorsItem[];
+}
+export type ListImagesParams = {
+    ownerType?: OwnerType;
+    ownerId?: string;
+    status?: ImageStatus;
+    /**
+     * @minimum 1
+     */
+    page?: number;
+    /**
+     * @minimum 1
+     * @maximum 200
+     */
+    pageSize?: number;
+};
+export type ListImages200 = {
+    items?: Image[];
+    page?: number;
+    pageSize?: number;
+    total?: number;
+};
+export type DeleteImageParams = {
+    /**
+     * If true — delete objects in MinIO and remove DB record permanently
+     */
+    hard?: boolean;
+};
+export type GetDeliveryUrlParams = {
+    /**
+     * Name of a pre-generated variant (if exists)
+     */
+    variant?: string;
+    /**
+     * @minimum 1
+     */
+    w?: number;
+    /**
+     * @minimum 1
+     */
+    h?: number;
+    fit?: GetDeliveryUrlFit;
+    format?: GetDeliveryUrlFormat;
+    /**
+     * @minimum 1
+     * @maximum 100
+     */
+    quality?: number;
+    /**
+     * @minimum 0.5
+     * @maximum 3
+     */
+    dpr?: number;
+    /**
+     * If imgproxy is configured with signature expiration, an `expires` param will be included
+     * @minimum 0
+     */
+    ttlSeconds?: number;
+};
+export type GetDeliveryUrlFit = typeof GetDeliveryUrlFit[keyof typeof GetDeliveryUrlFit];
+export declare const GetDeliveryUrlFit: {
+    readonly cover: "cover";
+    readonly contain: "contain";
+    readonly fill: "fill";
+    readonly inside: "inside";
+    readonly outside: "outside";
+};
+export type GetDeliveryUrlFormat = typeof GetDeliveryUrlFormat[keyof typeof GetDeliveryUrlFormat];
+export declare const GetDeliveryUrlFormat: {
+    readonly original: "original";
+    readonly webp: "webp";
+    readonly avif: "avif";
+    readonly jpeg: "jpeg";
+    readonly png: "png";
+};
+export type GetDeliveryUrl200 = {
+    url: string;
+    expiresAt?: string;
+};
+export type PromoteImages200 = {
+    promoted?: Image[];
+};
+export type ProcessImageBody = {
+    imageId?: string;
+    /** Name of the preset (variant set), if used */
+    preset?: string;
+};

package/dist/api.schemas.js

@@ -0,0 +1,60 @@
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const OwnerType = {
+    productDraft: 'productDraft',
+    product: 'product',
+    user: 'user',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ImageRole = {
+    main: 'main',
+    gallery: 'gallery',
+    other: 'other',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const ImageStatus = {
+    pending: 'pending',
+    uploaded: 'uploaded',
+    processing: 'processing',
+    ready: 'ready',
+    failed: 'failed',
+    deleted: 'deleted',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const PresignRequestContentType = {
+    'image/jpeg': 'image/jpeg',
+    'image/png': 'image/png',
+    'image/webp': 'image/webp',
+    'image/avif': 'image/avif',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const BatchUrlRequestFit = {
+    cover: 'cover',
+    contain: 'contain',
+    fill: 'fill',
+    inside: 'inside',
+    outside: 'outside',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const BatchUrlRequestFormat = {
+    original: 'original',
+    webp: 'webp',
+    avif: 'avif',
+    jpeg: 'jpeg',
+    png: 'png',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const GetDeliveryUrlFit = {
+    cover: 'cover',
+    contain: 'contain',
+    fill: 'fill',
+    inside: 'inside',
+    outside: 'outside',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const GetDeliveryUrlFormat = {
+    original: 'original',
+    webp: 'webp',
+    avif: 'avif',
+    jpeg: 'jpeg',
+    png: 'png',
+};

package/dist/index.d.ts

@@ -1,13 +1,2 @@
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export * from "./api";
-export * from "./configuration";
+export * from './api';
+export * from './api.schemas';

package/dist/index.js

@@ -1,15 +1,2 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-export * from "./api";
-export * from "./configuration";
+export * from './api';
+export * from './api.schemas';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sokol111/ecommerce-image-service-api",
   "description": "Generated TypeScript Axios client from OpenAPI for ecommerce-image-service-api",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -10,17 +10,12 @@
     "prepare": "npm run build"
   },
   "keywords": ["openapi", "typescript", "axios", "sdk"],
-  "author": "Sokol111",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Sokol111/ecommerce-image-service-api.git"
-  },
   "dependencies": {
-    "axios": "^1.6.1"
+    "axios": "^1.10.0"
   },
   "devDependencies": {
-    "typescript": "^5.4.0"
+    "typescript": "^5"
   },
   "publishConfig": {
     "access": "public"

package/dist/base.d.ts

@@ -1,42 +0,0 @@
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { Configuration } from './configuration';
-import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
-export declare const BASE_PATH: string;
-export declare const COLLECTION_FORMATS: {
-    csv: string;
-    ssv: string;
-    tsv: string;
-    pipes: string;
-};
-export interface RequestArgs {
-    url: string;
-    options: RawAxiosRequestConfig;
-}
-export declare class BaseAPI {
-    protected basePath: string;
-    protected axios: AxiosInstance;
-    protected configuration: Configuration | undefined;
-    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
-}
-export declare class RequiredError extends Error {
-    field: string;
-    constructor(field: string, msg?: string);
-}
-interface ServerMap {
-    [key: string]: {
-        url: string;
-        description: string;
-    }[];
-}
-export declare const operationServerMap: ServerMap;
-export {};

package/dist/base.js

@@ -1,41 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import globalAxios from 'axios';
-export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-export class BaseAPI {
-    constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
-        var _a;
-        this.basePath = basePath;
-        this.axios = axios;
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = (_a = configuration.basePath) !== null && _a !== void 0 ? _a : basePath;
-        }
-    }
-}
-;
-export class RequiredError extends Error {
-    constructor(field, msg) {
-        super(msg);
-        this.field = field;
-        this.name = "RequiredError";
-    }
-}
-export const operationServerMap = {};

package/dist/common.d.ts

@@ -1,28 +0,0 @@
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { Configuration } from "./configuration";
-import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-export declare const DUMMY_BASE_URL = "https://example.com";
-/**
- *
- * @throws {RequiredError}
- */
-export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
-export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
-export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
-export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
-export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
-export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
-export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
-export declare const toPathString: (url: URL) => string;
-export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/common.js

@@ -1,112 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Image Service API
- * API for managing images
- *
- * The version of the OpenAPI document: 1.0.27
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { RequiredError } from "./base";
-export const DUMMY_BASE_URL = 'https://example.com';
-/**
- *
- * @throws {RequiredError}
- */
-export const assertParamExists = function (functionName, paramName, paramValue) {
-    if (paramValue === null || paramValue === undefined) {
-        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
-    }
-};
-export const setApiKeyToObject = function (object, keyParamName, configuration) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (configuration && configuration.apiKey) {
-            const localVarApiKeyValue = typeof configuration.apiKey === 'function'
-                ? yield configuration.apiKey(keyParamName)
-                : yield configuration.apiKey;
-            object[keyParamName] = localVarApiKeyValue;
-        }
-    });
-};
-export const setBasicAuthToObject = function (object, configuration) {
-    if (configuration && (configuration.username || configuration.password)) {
-        object["auth"] = { username: configuration.username, password: configuration.password };
-    }
-};
-export const setBearerAuthToObject = function (object, configuration) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (configuration && configuration.accessToken) {
-            const accessToken = typeof configuration.accessToken === 'function'
-                ? yield configuration.accessToken()
-                : yield configuration.accessToken;
-            object["Authorization"] = "Bearer " + accessToken;
-        }
-    });
-};
-export const setOAuthToObject = function (object, name, scopes, configuration) {
-    return __awaiter(this, void 0, void 0, function* () {
-        if (configuration && configuration.accessToken) {
-            const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
-                ? yield configuration.accessToken(name, scopes)
-                : yield configuration.accessToken;
-            object["Authorization"] = "Bearer " + localVarAccessTokenValue;
-        }
-    });
-};
-function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
-    if (parameter == null)
-        return;
-    if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
-            parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        }
-        else {
-            Object.keys(parameter).forEach(currentKey => setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`));
-        }
-    }
-    else {
-        if (urlSearchParams.has(key)) {
-            urlSearchParams.append(key, parameter);
-        }
-        else {
-            urlSearchParams.set(key, parameter);
-        }
-    }
-}
-export const setSearchParams = function (url, ...objects) {
-    const searchParams = new URLSearchParams(url.search);
-    setFlattenedQueryParams(searchParams, objects);
-    url.search = searchParams.toString();
-};
-export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
-    const nonString = typeof value !== 'string';
-    const needsSerialization = nonString && configuration && configuration.isJsonMime
-        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
-        : nonString;
-    return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
-        : (value || "");
-};
-export const toPathString = function (url) {
-    return url.pathname + url.search + url.hash;
-};
-export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
-    return (axios = globalAxios, basePath = BASE_PATH) => {
-        var _a;
-        const axiosRequestArgs = Object.assign(Object.assign({}, axiosArgs.options), { url: (axios.defaults.baseURL ? '' : (_a = configuration === null || configuration === void 0 ? void 0 : configuration.basePath) !== null && _a !== void 0 ? _a : basePath) + axiosArgs.url });
-        return axios.request(axiosRequestArgs);
-    };
-};