@fluidattacks/design 1.2.9 → 1.2.11

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/psdTools/ClipAction.d.ts

@@ -0,0 +1,31 @@
+import { Action } from '../../internal/Action.js';
+/**
+ * @description  Defines the clipping path to use when trimming pixels.
+ * @extends SDK.Action
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
+ */
+declare class ClipAction extends Action {
+    private path;
+    private isEvenOdd;
+    constructor();
+    /**
+     * @description The name of the path to clip by
+     * @param {string} path
+     * @return {this}
+     */
+    byName(path: string): this;
+    /**
+     * @description The index of the path to clip by
+     * @param {number} path
+     * @return {this}
+     */
+    byIndex(path: number): this;
+    /**
+     * @description Trims pixels according to a clipping path included in the original image using an evenodd clipping rule.
+     * @return {this}
+     */
+    evenOdd(): this;
+    protected prepareQualifiers(): this;
+}
+export { ClipAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/psdTools/GetLayerAction.d.ts

@@ -0,0 +1,31 @@
+import { Action } from '../../internal/Action.js';
+/**
+ * @description Represents a layer in a Photoshop document.
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
+ * @extends SDK.Action
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
+ */
+declare class GetLayerAction extends Action {
+    private name;
+    private qualifierValue;
+    constructor();
+    /**
+     * @description deliver an image containing only specified layer of a Photoshop image from The layer index
+     * @param {string|number} from the index of the layer
+     */
+    byIndex(from: string | number): this;
+    /**
+     * @description deliver an image containing only specified range of layers of a Photoshop image
+     * @param {string|number} from The layer number
+     * @param {string|number} to The layer number
+     */
+    byRange(from: string | number, to: string | number): this;
+    /**
+     * @description deliver an image containing only specified layer by name of a Photoshop image
+     * @param {string|number} name The layer by name
+     */
+    byName(name: string): this;
+    protected prepareQualifiers(): this;
+}
+export { GetLayerAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/psdTools/SmartObjectAction.d.ts

@@ -0,0 +1,26 @@
+import { Action } from '../../internal/Action.js';
+/**
+ * @description Represents an embedded smart object in a Photoshop document.
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#extract_the_original_content_of_an_embedded_object|Extract the original content of an embedded Photoshop object}
+ * @extends SDK.Action
+ * @memberOf Actions.PSDTools
+ * @see Visit {@link Actions.PSDTools| PSDTools} for an example
+ */
+declare class SmartObjectAction extends Action {
+    private smartObjectValue;
+    private qualifierValue;
+    private useName;
+    constructor();
+    /**
+     * @description Creates a new instance using the specified number.
+     * @param index The number.
+     */
+    byIndex(index: string | number): this;
+    /**
+     * @description Creates an instance using the name.
+     * @param {string} layerName The name of the layer
+     */
+    byLayerName(layerName: string): this;
+    protected prepareQualifiers(): void;
+}
+export { SmartObjectAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/psdTools.d.ts

@@ -0,0 +1,78 @@
+import { ClipAction } from './psdTools/ClipAction.js';
+import { GetLayerAction } from './psdTools/GetLayerAction.js';
+import { SmartObjectAction } from './psdTools/SmartObjectAction.js';
+/**
+ * @namespace PSDTools
+ * @description Represents a layer in a Photoshop document.
+ * </br><b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
+ * @memberOf Actions
+ * @example
+ * // See examples under each method
+ */
+/**
+ * @summary action
+ * @description Trims the pixels of a PSD image according to a Photoshop clipping path that is stored in the image's metadata.
+ * @memberOf Actions.PSDTools
+ * @return {Actions.PSDTools.ClipAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/url-gen';
+ * import {clip} from '@cloudinary/url-gen/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  clip()
+ *    .byName('foo') // either name, or number
+ *    .byNumber(2)   // either name, or number
+ *    .evenOdd()     // Use the evenodd clipping rule
+ * );
+ */
+declare function clip(): ClipAction;
+/**
+ * @summary action
+ * @description Delivers an image containing only specified layers of a Photoshop image.
+ *
+ * <b>Learn more:</b> {@link https://cloudinary.com/documentation/paged_and_layered_media#deliver_selected_layers_of_a_psd_image|Deliver selected layers of a PSD image}
+ * @memberOf Actions.PSDTools
+ * @return {Actions.PSDTools.GetLayerAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/url-gen';
+ * import {getLayer} from '@cloudinary/url-gen/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  getLayer()
+ *    .byName('foo') // One of the three
+ *    .byIndex(2)    // One of the three
+ *    .byRange(1, 3) // One of the three
+ * );
+ */
+declare function getLayer(): GetLayerAction;
+/**
+ * @summary action
+ * @description Extracts the original content of an embedded object of a Photoshop image.
+ * @memberOf Actions.PSDTools
+ * @return {Actions.PSDTools.SmartObjectAction}
+ * @example
+ * import {Cloudinary} from '@cloudinary/url-gen';
+ * import {smartObject} from '@cloudinary/url-gen/actions/psdTools';
+ *
+ * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
+ * const image = yourCldInstance.image('woman');
+ *
+ * image.psdTools(
+ *  smartObject()
+ *    .byLayerName('foo') // either name, or number
+ *    .byIndex(2)         // either name, or number
+ * );
+ */
+declare function smartObject(): SmartObjectAction;
+declare const PSDTools: {
+    clip: typeof clip;
+    getLayer: typeof getLayer;
+    smartObject: typeof smartObject;
+};
+export { PSDTools, clip, getLayer, smartObject };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeAdvancedAction.d.ts

@@ -0,0 +1,20 @@
+import { ResizeSimpleAction } from './ResizeSimpleAction.js';
+import { IGravity } from '../../qualifiers/gravity/GravityQualifier.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+import { IResizeAdvancedActionModel } from '../../internal/models/IResizeAdvancedActionModel.js';
+/**
+ * @description Defines an advanced resize.
+ * @extends Actions.Resize.ResizeSimpleAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeAdvancedAction extends ResizeSimpleAction {
+    protected _actionModel: IResizeAdvancedActionModel;
+    /**
+     * @description Which part of the original image to include.
+     * @param {Qualifiers.Gravity} gravity
+     */
+    gravity(gravity: IGravity): this;
+    static fromJson(actionModel: IActionModel): ResizeAdvancedAction;
+}
+export { ResizeAdvancedAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeAutoPadAction.d.ts

@@ -0,0 +1,22 @@
+import { BackgroundQualifier } from '../../qualifiers/background/shared/base/BackgroundQualifier.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+import { ResizeSimpleAction } from './ResizeSimpleAction.js';
+import { IGravity } from '../../qualifiers/gravity/GravityQualifier.js';
+/**
+ * @description Tries to prevent a "bad crop" by first attempting to use the auto cropping mode, but adding some padding if the algorithm determines that more of the original image needs to be included in the final image.
+ * @extends Actions.Resize.autoPad
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeAutoPadAction extends ResizeSimpleAction {
+    constructor(cropType: string, cropWidth: number | string, cropHeight?: number | string);
+    /**
+     * @description Sets the background.
+     * @param {Qualifiers.Background} backgroundQualifier Defines the background color to use instead of
+     * transparent background areas or when resizing with padding.
+     */
+    background(backgroundQualifier: BackgroundQualifier | string): this;
+    gravity(gravity: IGravity): this;
+    static fromJson(actionModel: IActionModel): ResizeAutoPadAction;
+}
+export { ResizeAutoPadAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeCropAction.d.ts

@@ -0,0 +1,27 @@
+import { ResizeAdvancedAction } from './ResizeAdvancedAction.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+/**
+ * @description Defines how to crop an asset
+ * @extends Actions.Resize.ResizeAdvancedAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeCropAction extends ResizeAdvancedAction {
+    /**
+     * @description Horizontal position for custom-coordinates based cropping.
+     * @param {number} x The x position.
+     */
+    x(x: number | string): this;
+    /**
+     * @description Vertical position for custom-coordinates based cropping
+     * @param {number} y The y position.
+     */
+    y(y: number | string): this;
+    /**
+     * @description Controls how much of the original image surrounding the face to keep when using either the 'crop' or 'thumb' cropping modes with face detection.
+     * @param {number | string} z The zoom factor. (Default: 1.0)
+     */
+    zoom(z: number | string): this;
+    static fromJson(actionModel: IActionModel): ResizeCropAction;
+}
+export { ResizeCropAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeFillAction.d.ts

@@ -0,0 +1,22 @@
+import { ResizeAdvancedAction } from './ResizeAdvancedAction.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+/**
+ * @description Defines how to crop-fill an asset
+ * @extends Actions.Resize.ResizeAdvancedAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeFillAction extends ResizeAdvancedAction {
+    /**
+     * @description Absolute X position when used with Gravity.xyCenter {@link Qualifiers.Gravity.GravityQualifier}}
+     * @param {number} x The x position.
+     */
+    x(x: number | string): this;
+    /**
+     * @description Absolute Y position when used with Gravity.xyCenter {@link Qualifiers.Gravity.GravityQualifier}}
+     * @param {number} y The y position.
+     */
+    y(y: number | string): this;
+    static fromJson(actionModel: IActionModel): ResizeFillAction;
+}
+export { ResizeFillAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeLimitFillAction.d.ts

@@ -0,0 +1,10 @@
+import { ResizeFillAction } from './ResizeFillAction.js';
+/**
+ * @description Defines how to crop-limit-fill an asset
+ * @extends Actions.Resize.ResizeFillAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeLimitFillAction extends ResizeFillAction {
+}
+export { ResizeLimitFillAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeLimitFitAction.d.ts

@@ -0,0 +1,10 @@
+import { ResizeSimpleAction } from './ResizeSimpleAction.js';
+/**
+ * @description Defines a limit fitting resize action.
+ * @extends Actions.Resize.ResizeSimpleAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeLimitFitAction extends ResizeSimpleAction {
+}
+export { ResizeLimitFitAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeLimitPadAction.d.ts

@@ -0,0 +1,11 @@
+import { IGravity } from '../../qualifiers/gravity/GravityQualifier.js';
+import { ResizePadAction } from './ResizePadAction.js';
+/**
+ * @description Defines an advanced resize with limit padding.
+ * @extends Actions.Resize.ResizePadAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeLimitPadAction<GravityType extends IGravity> extends ResizePadAction<GravityType> {
+}
+export { ResizeLimitPadAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeMinimumPadAction.d.ts

@@ -0,0 +1,11 @@
+import { IGravity } from '../../qualifiers/gravity/GravityQualifier.js';
+import { ResizePadAction } from './ResizePadAction.js';
+/**
+ * @description Defines an advanced resize with minimum padding.
+ * @extends Actions.Resize.ResizePadAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeMinimumPadAction<GravityType extends IGravity> extends ResizePadAction<GravityType> {
+}
+export { ResizeMinimumPadAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizePadAction.d.ts

@@ -0,0 +1,31 @@
+import { BackgroundQualifier } from '../../qualifiers/background/shared/base/BackgroundQualifier.js';
+import { IGravity } from '../../qualifiers/gravity/GravityQualifier.js';
+import { ResizeAdvancedAction } from './ResizeAdvancedAction.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+import { CompassGravity } from '../../qualifiers/gravity/compassGravity/CompassGravity.js';
+/**
+ * @description Defines an advanced resize with padding.
+ * @extends Actions.Resize.ResizeAdvancedAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizePadAction<GravityType extends IGravity> extends ResizeAdvancedAction {
+    /**
+     * @description Sets the background.
+     * @param {Qualifiers.Background} backgroundQualifier Defines the background color to use instead of
+     * transparent background areas or when resizing with padding.
+     */
+    background(backgroundQualifier: BackgroundQualifier | string): this;
+    /**
+     * @description Horizontal position for custom-coordinates based padding.
+     * @param {number} x The x position.
+     */
+    offsetX(x: number | string): this;
+    /**
+     * @description Vertical position for custom-coordinates based padding
+     * @param {number} y The y position.
+     */
+    offsetY(y: number | string): this;
+    static fromJson(actionModel: IActionModel): ResizePadAction<CompassGravity>;
+}
+export { ResizePadAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeScaleAction.d.ts

@@ -0,0 +1,16 @@
+import { ResizeSimpleAction } from './ResizeSimpleAction.js';
+/**
+ * @description Defines a scaling resize action.
+ * @extends Actions.Resize.ResizeSimpleAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeScaleAction extends ResizeSimpleAction {
+    /**
+     * @description Changes the aspect ratio of an image while retaining all important content and avoiding unnatural
+     * distortions.
+     * @return {this}
+     */
+    liquidRescaling(): this;
+}
+export { ResizeScaleAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ResizeSimpleAction.d.ts

@@ -0,0 +1,52 @@
+import { Action } from '../../internal/Action.js';
+import { AspectRatioQualifierValue } from '../../qualifiers/aspectRatio/AspectRatioQualifierValue.js';
+import { FlagQualifier } from '../../qualifiers/flag/FlagQualifier.js';
+import { ExpressionQualifier } from '../../qualifiers/expression/ExpressionQualifier.js';
+import { AspectRatioType } from '../../types/types.js';
+import { IResizeSimpleActionModel } from '../../internal/models/IResizeSimpleActionModel.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+/**
+ * @description Defines a resize using width and height.
+ * @extends SDK.Action
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ResizeSimpleAction extends Action {
+    protected _actionModel: IResizeSimpleActionModel;
+    /**
+     * @param {string} cropType
+     * @param {number | string} cropWidth The required width of a transformed asset.
+     * @param {number | string} cropHeight The required height of a transformed asset.
+     */
+    constructor(cropType: string, cropWidth: number | string, cropHeight?: number | string);
+    /**
+     * @description Sets the height of the resize
+     * @param {string | number} x The height in pixels (if an integer is specified) or as a percentage (if a float is specified).
+     */
+    height(x: number | string | ExpressionQualifier): this;
+    /**
+     * @description Sets the width of the resize
+     * @param {string | number} x The width in pixels (if an integer is specified) or as a percentage (if a float is specified).
+     */
+    width(x: number | string | ExpressionQualifier): this;
+    /**
+     * @description Sets the aspect ratio of the asset.
+     * For a list of supported types see {@link Qualifiers.AspectRatio|
+      * AspectRatio values}
+     * @param {AspectRatioType|number|string} ratio The new aspect ratio, specified as a percentage or ratio.
+     * @return {this}
+     */
+    aspectRatio(ratio: AspectRatioType | AspectRatioQualifierValue | FlagQualifier | number | string): this;
+    /**
+     * @description Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the containing image instead of the added layer.
+     * @return {this}
+     */
+    relative(): this;
+    /**
+     * @description Modifies percentage-based width & height parameters of overlays and underlays (e.g., 1.0) to be relative to the overlaid region
+     * @return {this}
+     */
+    regionRelative(): this;
+    static fromJson(actionModel: IActionModel): ResizeSimpleAction;
+}
+export { ResizeSimpleAction };

package/dist/node_modules/@cloudinary/transformation-builder-sdk/actions/resize/ThumbnailAction.d.ts

@@ -0,0 +1,17 @@
+import { ResizeAdvancedAction } from './ResizeAdvancedAction.js';
+import { IActionModel } from '../../internal/models/IActionModel.js';
+/**
+ * @description Defines a thumbnail resize action.
+ * @extends Actions.Resize.ResizeAdvancedAction
+ * @memberOf Actions.Resize
+ * @see Visit {@link Actions.Resize| Resize} for examples
+ */
+declare class ThumbResizeAction extends ResizeAdvancedAction {
+    /**
+     * @description Controls how much of the original image surrounding the face to keep when using either the 'crop' or 'thumb' cropping modes with face detection.
+     * @param {number | string} z The zoom factor. (Default: 1.0)
+     */
+    zoom(z: number | string): this;
+    static fromJson(actionModel: IActionModel): ThumbResizeAction;
+}
+export { ThumbResizeAction };