@salsita-ai/contracts 0.0.0-stage → 0.49.0-develop.cbee856178

package/dist/webhook/tasks/generate-images-task.d.ts

@@ -0,0 +1,404 @@
+import { z } from 'zod';
+import { TaskType } from '../core/index.js';
+/**
+ * PBR material values applied to a named material in the Blender template.
+ * For texture maps, a URL applies a map, `null` removes the authored map, and omission preserves it.
+ */
+export interface BlenderMaterialOverride {
+    /** Name of the material in the Blender template. */
+    readonly baseMaterialName: string;
+    /** Base color as a six-digit hex color. */
+    readonly color?: string | undefined;
+    /** Surface roughness. */
+    readonly roughness?: number | undefined;
+    /** Surface metalness. */
+    readonly metalness?: number | undefined;
+    /** Base-color texture map. */
+    readonly textureUrl?: string | null | undefined;
+    /** Roughness texture map. */
+    readonly roughnessMapUrl?: string | null | undefined;
+    /** Tangent-space normal texture map. */
+    readonly normalMapUrl?: string | null | undefined;
+    /** Strength of the normal-map effect. */
+    readonly normalScale?: number | undefined;
+    /** Ambient-occlusion texture map. */
+    readonly aoMapUrl?: string | null | undefined;
+    /** Strength of the ambient-occlusion map. */
+    readonly aoMapIntensity?: number | undefined;
+    /** Bump texture map. */
+    readonly bumpMapUrl?: string | null | undefined;
+    /** Strength of the bump-map effect. */
+    readonly bumpScale?: number | undefined;
+    /** Metalness texture map. */
+    readonly metalnessMapUrl?: string | null | undefined;
+    /** Emissive color as a six-digit hex color. */
+    readonly emissive?: string | undefined;
+    /** Strength of the emissive color. */
+    readonly emissiveIntensity?: number | undefined;
+    /** Alpha texture map. */
+    readonly alphaMapUrl?: string | null | undefined;
+    /** Whether the material uses Blender's transparent blend mode. */
+    readonly transparent?: boolean | undefined;
+    /** Material opacity from zero to one. */
+    readonly opacity?: number | undefined;
+    /** Clearcoat layer strength. */
+    readonly clearcoat?: number | undefined;
+    /** Clearcoat layer roughness. */
+    readonly clearcoatRoughness?: number | undefined;
+    /** Sheen layer strength. */
+    readonly sheen?: number | undefined;
+    /** Sheen layer roughness. */
+    readonly sheenRoughness?: number | undefined;
+    /** Sheen color as a six-digit hex color. */
+    readonly sheenColor?: string | undefined;
+    /** Specular reflection intensity. */
+    readonly specularIntensity?: number | undefined;
+    /** Specular reflection color as a six-digit hex color. */
+    readonly specularColor?: string | undefined;
+    /** Index of refraction. */
+    readonly ior?: number | undefined;
+    /** Transmission strength. */
+    readonly transmission?: number | undefined;
+    /** Anisotropic reflection strength. */
+    readonly anisotropyStrength?: number | undefined;
+    /** Anisotropic reflection rotation, in radians. */
+    readonly anisotropyRotation?: number | undefined;
+    /** Anisotropy texture map. */
+    readonly anisotropyMapUrl?: string | null | undefined;
+    /** Clearcoat texture map. */
+    readonly clearcoatMapUrl?: string | null | undefined;
+    /** Clearcoat roughness texture map. */
+    readonly clearcoatRoughnessMapUrl?: string | null | undefined;
+    /** Clearcoat normal texture map. */
+    readonly clearcoatNormalMapUrl?: string | null | undefined;
+    /** Strength of the clearcoat normal-map effect. */
+    readonly clearcoatNormalScale?: number | undefined;
+    /** Sheen color texture map. */
+    readonly sheenColorMapUrl?: string | null | undefined;
+    /** Sheen roughness texture map. */
+    readonly sheenRoughnessMapUrl?: string | null | undefined;
+    /** Specular intensity texture map. */
+    readonly specularIntensityMapUrl?: string | null | undefined;
+    /** Specular color texture map. */
+    readonly specularColorMapUrl?: string | null | undefined;
+    /** Transmission texture map. */
+    readonly transmissionMapUrl?: string | null | undefined;
+    /** Displacement texture map. */
+    readonly displacementMapUrl?: string | null | undefined;
+    /** Strength of geometry displacement. */
+    readonly displacementScale?: number | undefined;
+    /** Horizontal texture repeat factor. */
+    readonly repeatX?: number | undefined;
+    /** Vertical texture repeat factor. */
+    readonly repeatY?: number | undefined;
+}
+export interface DefaultRenderedEntity {
+    readonly id: string;
+    readonly type: 'default';
+    readonly objectName: string;
+    readonly position: [number, number, number];
+    readonly rotation?: [number, number, number, number];
+    /** Scale multiplied with the Blender template object's authored scale. */
+    readonly scale?: [number, number, number];
+    readonly materialOverrides?: Record<string, BlenderMaterialOverride>;
+    readonly morphTargetInfluences?: Record<string, number>;
+}
+export declare const BlenderMaterialOverrideSchema: z.ZodObject<{
+    baseMaterialName: z.ZodString;
+    color: z.ZodOptional<z.ZodString>;
+    roughness: z.ZodOptional<z.ZodNumber>;
+    metalness: z.ZodOptional<z.ZodNumber>;
+    textureUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    roughnessMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    normalMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    normalScale: z.ZodOptional<z.ZodNumber>;
+    aoMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    aoMapIntensity: z.ZodOptional<z.ZodNumber>;
+    bumpMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bumpScale: z.ZodOptional<z.ZodNumber>;
+    metalnessMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    emissive: z.ZodOptional<z.ZodString>;
+    emissiveIntensity: z.ZodOptional<z.ZodNumber>;
+    alphaMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    transparent: z.ZodOptional<z.ZodBoolean>;
+    opacity: z.ZodOptional<z.ZodNumber>;
+    clearcoat: z.ZodOptional<z.ZodNumber>;
+    clearcoatRoughness: z.ZodOptional<z.ZodNumber>;
+    sheen: z.ZodOptional<z.ZodNumber>;
+    sheenRoughness: z.ZodOptional<z.ZodNumber>;
+    sheenColor: z.ZodOptional<z.ZodString>;
+    specularIntensity: z.ZodOptional<z.ZodNumber>;
+    specularColor: z.ZodOptional<z.ZodString>;
+    ior: z.ZodOptional<z.ZodNumber>;
+    transmission: z.ZodOptional<z.ZodNumber>;
+    anisotropyStrength: z.ZodOptional<z.ZodNumber>;
+    anisotropyRotation: z.ZodOptional<z.ZodNumber>;
+    anisotropyMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    clearcoatMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    clearcoatRoughnessMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    clearcoatNormalMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    clearcoatNormalScale: z.ZodOptional<z.ZodNumber>;
+    sheenColorMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    sheenRoughnessMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    specularIntensityMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    specularColorMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    transmissionMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    displacementMapUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    displacementScale: z.ZodOptional<z.ZodNumber>;
+    repeatX: z.ZodOptional<z.ZodNumber>;
+    repeatY: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    baseMaterialName: string;
+    color?: string | undefined;
+    roughness?: number | undefined;
+    metalness?: number | undefined;
+    textureUrl?: string | null | undefined;
+    roughnessMapUrl?: string | null | undefined;
+    normalMapUrl?: string | null | undefined;
+    normalScale?: number | undefined;
+    aoMapUrl?: string | null | undefined;
+    aoMapIntensity?: number | undefined;
+    bumpMapUrl?: string | null | undefined;
+    bumpScale?: number | undefined;
+    metalnessMapUrl?: string | null | undefined;
+    emissive?: string | undefined;
+    emissiveIntensity?: number | undefined;
+    alphaMapUrl?: string | null | undefined;
+    transparent?: boolean | undefined;
+    opacity?: number | undefined;
+    clearcoat?: number | undefined;
+    clearcoatRoughness?: number | undefined;
+    sheen?: number | undefined;
+    sheenRoughness?: number | undefined;
+    sheenColor?: string | undefined;
+    specularIntensity?: number | undefined;
+    specularColor?: string | undefined;
+    ior?: number | undefined;
+    transmission?: number | undefined;
+    anisotropyStrength?: number | undefined;
+    anisotropyRotation?: number | undefined;
+    anisotropyMapUrl?: string | null | undefined;
+    clearcoatMapUrl?: string | null | undefined;
+    clearcoatRoughnessMapUrl?: string | null | undefined;
+    clearcoatNormalMapUrl?: string | null | undefined;
+    clearcoatNormalScale?: number | undefined;
+    sheenColorMapUrl?: string | null | undefined;
+    sheenRoughnessMapUrl?: string | null | undefined;
+    specularIntensityMapUrl?: string | null | undefined;
+    specularColorMapUrl?: string | null | undefined;
+    transmissionMapUrl?: string | null | undefined;
+    displacementMapUrl?: string | null | undefined;
+    displacementScale?: number | undefined;
+    repeatX?: number | undefined;
+    repeatY?: number | undefined;
+}, {
+    baseMaterialName: string;
+    color?: string | undefined;
+    roughness?: number | undefined;
+    metalness?: number | undefined;
+    textureUrl?: string | null | undefined;
+    roughnessMapUrl?: string | null | undefined;
+    normalMapUrl?: string | null | undefined;
+    normalScale?: number | undefined;
+    aoMapUrl?: string | null | undefined;
+    aoMapIntensity?: number | undefined;
+    bumpMapUrl?: string | null | undefined;
+    bumpScale?: number | undefined;
+    metalnessMapUrl?: string | null | undefined;
+    emissive?: string | undefined;
+    emissiveIntensity?: number | undefined;
+    alphaMapUrl?: string | null | undefined;
+    transparent?: boolean | undefined;
+    opacity?: number | undefined;
+    clearcoat?: number | undefined;
+    clearcoatRoughness?: number | undefined;
+    sheen?: number | undefined;
+    sheenRoughness?: number | undefined;
+    sheenColor?: string | undefined;
+    specularIntensity?: number | undefined;
+    specularColor?: string | undefined;
+    ior?: number | undefined;
+    transmission?: number | undefined;
+    anisotropyStrength?: number | undefined;
+    anisotropyRotation?: number | undefined;
+    anisotropyMapUrl?: string | null | undefined;
+    clearcoatMapUrl?: string | null | undefined;
+    clearcoatRoughnessMapUrl?: string | null | undefined;
+    clearcoatNormalMapUrl?: string | null | undefined;
+    clearcoatNormalScale?: number | undefined;
+    sheenColorMapUrl?: string | null | undefined;
+    sheenRoughnessMapUrl?: string | null | undefined;
+    specularIntensityMapUrl?: string | null | undefined;
+    specularColorMapUrl?: string | null | undefined;
+    transmissionMapUrl?: string | null | undefined;
+    displacementMapUrl?: string | null | undefined;
+    displacementScale?: number | undefined;
+    repeatX?: number | undefined;
+    repeatY?: number | undefined;
+}>;
+export declare const DefaultRenderedEntity: z.ZodType<DefaultRenderedEntity>;
+/**
+ * Custom entity to be rendered that is not supported by the rendering script out of the box and needs to be handled by a custom rendering script
+ */
+export interface CustomRenderedEntity {
+    readonly id: string;
+    readonly type: 'custom';
+    readonly objectName: string;
+    readonly [key: string]: unknown;
+}
+export declare const CustomRenderedEntity: z.ZodType<CustomRenderedEntity>;
+export type RenderedEntity = DefaultRenderedEntity | CustomRenderedEntity;
+export declare const RenderedEntity: z.ZodType<RenderedEntity>;
+/** Depth-of-field settings for a Blender render camera. */
+export interface BlenderCameraDof {
+    /** Whether depth of field is enabled. */
+    readonly enabled: boolean;
+    /** Aperture size in f-stops. */
+    readonly apertureFstop?: number;
+    /** Focus distance in Blender units. */
+    readonly focusDistance?: number;
+}
+/** Blender scene and render-engine settings applied by the render worker. */
+export interface BlenderRenderSettings {
+    /** View-transform exposure. */
+    readonly exposure?: number;
+    /** Blender color-management view transform. */
+    readonly viewTransform?: 'AgX' | 'Filmic' | 'Standard' | 'Raw';
+    /** Blender look preset for the selected view transform. */
+    readonly look?: string;
+    /** Display/view gamma. */
+    readonly gamma?: number;
+    /** Private deployment asset path to the HDRI image. */
+    readonly hdriFile?: string;
+    /** Strength of the world background shader. */
+    readonly hdriStrength?: number;
+    /** HDRI rotation around the Z axis, in radians. */
+    readonly hdriRotation?: number;
+    /** Whether the rendered film has a transparent background. */
+    readonly filmTransparent?: boolean;
+    /** Render samples for Cycles or EEVEE. */
+    readonly samples?: number;
+    /** Whether Cycles denoising is enabled. */
+    readonly useDenoising?: boolean;
+    /** Cycles denoiser engine. */
+    readonly denoiser?: 'OPENIMAGEDENOISE' | 'OPTIX';
+    /** Maximum number of Cycles light-path bounces. */
+    readonly maxBounces?: number;
+    /** Maximum number of Cycles diffuse bounces. */
+    readonly diffuseBounces?: number;
+    /** Maximum number of Cycles glossy bounces. */
+    readonly glossyBounces?: number;
+    /** Whether a glare/fog-glow compositor pass is enabled. */
+    readonly glareEnabled?: boolean;
+    /** Brightness threshold for the glare effect. */
+    readonly glareThreshold?: number;
+    /** Mix intensity of the glare effect. */
+    readonly glareIntensity?: number;
+    /** Lens-distortion amount. */
+    readonly lensDistortion?: number;
+    /** Chromatic-aberration amount. */
+    readonly chromaticAberration?: number;
+    /** Vignette strength; values above zero enable the effect. */
+    readonly vignette?: number;
+    /** Film-grain strength; values above zero enable the effect. */
+    readonly filmGrain?: number;
+    /** Density of the world volume-scatter effect. */
+    readonly volumeScatterDensity?: number;
+    /** Anisotropy of the world volume-scatter effect, used when density is set. */
+    readonly volumeScatterAnisotropy?: number;
+}
+/** Light created in Blender for a rendered scene. */
+export interface BlenderLight {
+    /** Unique name for the Blender light and its scene object. */
+    readonly id: string;
+    /** Blender light type. */
+    readonly type: 'POINT' | 'SPOT' | 'SUN' | 'AREA';
+    /** Light position in Blender coordinates. */
+    readonly position: [number, number, number];
+    /** Six-digit hex light color. */
+    readonly color?: string;
+    /** Light energy in Blender. */
+    readonly intensity?: number;
+    /** Whether the light casts shadows. */
+    readonly castShadow?: boolean;
+    /** Physical radius of a point or spot light, controlling shadow softness. */
+    readonly radius?: number;
+    /** Half-angle of a spotlight cone, in radians. */
+    readonly angle?: number;
+    /** Spotlight edge softness from zero to one. */
+    readonly penumbra?: number;
+    /** Point in Blender coordinates that a spot, sun, or area light faces. */
+    readonly target?: [number, number, number];
+    /** Blender rotation quaternion in `(w, x, y, z)` order. */
+    readonly rotation?: [number, number, number, number];
+    /** Whether Blender displays the spotlight cone in the viewport. */
+    readonly showCone?: boolean;
+    /** Whether a spotlight uses a square rather than circular cone. */
+    readonly useSquare?: boolean;
+    /** Angular diameter of a sun light in radians, controlling shadow softness. */
+    readonly blenderAngle?: number;
+    /** Area-light width in millimeters. */
+    readonly width?: number;
+    /** Area-light height in millimeters. */
+    readonly height?: number;
+    /** Shape of the area-light emitter. */
+    readonly shape?: 'SQUARE' | 'RECTANGLE' | 'DISK' | 'ELLIPSE';
+    /** Angular spread of an area light, in radians. */
+    readonly spread?: number;
+    /** Specular reflection contribution. */
+    readonly specularFactor?: number;
+    /** Diffuse lighting contribution. */
+    readonly diffuseFactor?: number;
+    /** Volumetric-scatter contribution. */
+    readonly volumeFactor?: number;
+}
+export interface GenerateImagesTask {
+    readonly type: typeof TaskType.GenerateImages;
+    readonly deploymentId: string;
+    /**
+     * The name of the blender setup template file that will be used to render the images.
+     * It assumes that the template is uploaded to the private deployment assets
+     */
+    readonly blenderSetupTemplate: string;
+    /**
+     * The name of the python script that will be used to render the images, if not provided the default script will be used.
+     * It assumes that the script is uploaded to the private deployment assets
+     */
+    readonly blenderPythonScriptName?: string;
+    /**
+     * The template files that will be used to render the images. It assumes that the files are uploaded to the private deployment assets.
+     */
+    readonly templateFiles: readonly string[];
+    /** Render settings used as defaults for every image in this task. */
+    readonly renderSettings?: BlenderRenderSettings;
+    readonly images: ReadonlyArray<{
+        readonly name: string;
+        readonly fileFormat: 'PNG' | 'JPEG';
+        readonly width: number;
+        readonly height: number;
+        readonly renderedEntities: readonly RenderedEntity[];
+        /** Lights created for this image. */
+        readonly lights?: readonly BlenderLight[];
+        /** Render settings merged over the task-level defaults for this image. */
+        readonly renderSettings?: BlenderRenderSettings;
+        /**
+         * When omitted, the Blender setup template’s active camera (and any cameras in the file) are kept:
+         * the worker does not delete cameras or spawn a look-at camera.
+         */
+        readonly camera?: {
+            readonly position: [number, number, number];
+            readonly target: [number, number, number];
+            /** Vertical field of view in degrees. */
+            readonly fov?: number;
+            /** Camera depth-of-field settings. */
+            readonly dof?: BlenderCameraDof;
+            /** Camera sensor width in millimeters. */
+            readonly sensorWidth?: number;
+            /** Near clipping distance in Blender units. */
+            readonly clipStart?: number;
+            /** Far clipping distance in Blender units. */
+            readonly clipEnd?: number;
+        };
+    }>;
+}
+export declare const GenerateImagesTask: z.ZodType<GenerateImagesTask>;

package/dist/webhook/tasks/generate-images-task.js

@@ -0,0 +1 @@
+import{z as n}from"zod";import{TaskType as o}from"../core/index.js";export const BlenderMaterialOverrideSchema=n.object({baseMaterialName:n.string(),color:n.string().optional(),roughness:n.number().optional(),metalness:n.number().optional(),textureUrl:n.string().nullable().optional(),roughnessMapUrl:n.string().nullable().optional(),normalMapUrl:n.string().nullable().optional(),normalScale:n.number().optional(),aoMapUrl:n.string().nullable().optional(),aoMapIntensity:n.number().optional(),bumpMapUrl:n.string().nullable().optional(),bumpScale:n.number().optional(),metalnessMapUrl:n.string().nullable().optional(),emissive:n.string().optional(),emissiveIntensity:n.number().optional(),alphaMapUrl:n.string().nullable().optional(),transparent:n.boolean().optional(),opacity:n.number().optional(),clearcoat:n.number().optional(),clearcoatRoughness:n.number().optional(),sheen:n.number().optional(),sheenRoughness:n.number().optional(),sheenColor:n.string().optional(),specularIntensity:n.number().optional(),specularColor:n.string().optional(),ior:n.number().optional(),transmission:n.number().optional(),anisotropyStrength:n.number().optional(),anisotropyRotation:n.number().optional(),anisotropyMapUrl:n.string().nullable().optional(),clearcoatMapUrl:n.string().nullable().optional(),clearcoatRoughnessMapUrl:n.string().nullable().optional(),clearcoatNormalMapUrl:n.string().nullable().optional(),clearcoatNormalScale:n.number().optional(),sheenColorMapUrl:n.string().nullable().optional(),sheenRoughnessMapUrl:n.string().nullable().optional(),specularIntensityMapUrl:n.string().nullable().optional(),specularColorMapUrl:n.string().nullable().optional(),transmissionMapUrl:n.string().nullable().optional(),displacementMapUrl:n.string().nullable().optional(),displacementScale:n.number().optional(),repeatX:n.number().optional(),repeatY:n.number().optional()});export const DefaultRenderedEntity=n.object({id:n.string(),type:n.literal("default"),objectName:n.string(),position:n.tuple([n.number(),n.number(),n.number()]),rotation:n.tuple([n.number(),n.number(),n.number(),n.number()]).optional(),scale:n.tuple([n.number(),n.number(),n.number()]).optional(),materialOverrides:n.record(BlenderMaterialOverrideSchema).optional(),morphTargetInfluences:n.record(n.number()).optional()});export const CustomRenderedEntity=n.object({id:n.string(),objectName:n.string(),type:n.literal("custom")}).and(n.record(n.unknown()));export const RenderedEntity=n.union([DefaultRenderedEntity,CustomRenderedEntity]);let e=n.object({enabled:n.boolean(),apertureFstop:n.number().optional(),focusDistance:n.number().optional()}),t=n.object({exposure:n.number().optional(),viewTransform:n.enum(["AgX","Filmic","Standard","Raw"]).optional(),look:n.string().optional(),gamma:n.number().optional(),hdriFile:n.string().optional(),hdriStrength:n.number().optional(),hdriRotation:n.number().optional(),filmTransparent:n.boolean().optional(),samples:n.number().optional(),useDenoising:n.boolean().optional(),denoiser:n.enum(["OPENIMAGEDENOISE","OPTIX"]).optional(),maxBounces:n.number().optional(),diffuseBounces:n.number().optional(),glossyBounces:n.number().optional(),glareEnabled:n.boolean().optional(),glareThreshold:n.number().optional(),glareIntensity:n.number().optional(),lensDistortion:n.number().optional(),chromaticAberration:n.number().optional(),vignette:n.number().optional(),filmGrain:n.number().optional(),volumeScatterDensity:n.number().optional(),volumeScatterAnisotropy:n.number().optional()}),r=n.object({id:n.string(),type:n.enum(["POINT","SPOT","SUN","AREA"]),position:n.tuple([n.number(),n.number(),n.number()]),color:n.string().optional(),intensity:n.number().optional(),castShadow:n.boolean().optional(),radius:n.number().optional(),angle:n.number().optional(),penumbra:n.number().optional(),target:n.tuple([n.number(),n.number(),n.number()]).optional(),rotation:n.tuple([n.number(),n.number(),n.number(),n.number()]).optional(),showCone:n.boolean().optional(),useSquare:n.boolean().optional(),blenderAngle:n.number().optional(),width:n.number().optional(),height:n.number().optional(),shape:n.enum(["SQUARE","RECTANGLE","DISK","ELLIPSE"]).optional(),spread:n.number().optional(),specularFactor:n.number().optional(),diffuseFactor:n.number().optional(),volumeFactor:n.number().optional()});export const GenerateImagesTask=n.object({type:n.literal(o.GenerateImages),deploymentId:n.string(),blenderSetupTemplate:n.string(),blenderPythonScriptName:n.string().optional(),templateFiles:n.array(n.string()),renderSettings:t.optional(),images:n.array(n.object({name:n.string(),fileFormat:n.literal("PNG").or(n.literal("JPEG")),width:n.number(),height:n.number(),renderedEntities:n.array(RenderedEntity),lights:n.array(r).optional(),renderSettings:t.optional(),camera:n.object({position:n.tuple([n.number(),n.number(),n.number()]),target:n.tuple([n.number(),n.number(),n.number()]),fov:n.number().optional(),dof:e.optional(),sensorWidth:n.number().optional(),clipStart:n.number().optional(),clipEnd:n.number().optional()}).optional()}))});

package/dist/webhook/tasks/generate-pdf-task.d.ts

@@ -0,0 +1,188 @@
+import { z } from 'zod';
+import { type FinalizeTaskResource, StoredTemplate, TaskType, Template, TemplateResource } from '../core/index.js';
+export declare const PdfUnitValueSchema: z.ZodUnion<[z.ZodNumber, z.ZodString]>;
+/**
+ * A PDF unit value accepted by PdfShift. Numbers are interpreted as pixels.
+ */
+export type PdfUnitValue = z.infer<typeof PdfUnitValueSchema>;
+export interface GeneratePdfTask {
+    type: typeof TaskType.GeneratePdf;
+    /**
+     * The name of the pdf file
+     */
+    name: string;
+    html: StoredTemplate | Template;
+    /**
+     * You can define margin for the document (space between the limits of the document and the beginning of the content).
+     * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+     */
+    margin: {
+        top: PdfUnitValue;
+        right: PdfUnitValue;
+        bottom: PdfUnitValue;
+        left: PdfUnitValue;
+    };
+    /**
+     * Format of the document. You can either use the standard values (Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5)
+     * or a custom {width}x{height} value. For {width} and {height}, you can indicate the following units: in, cm, mm.
+     */
+    format?: string;
+    /**
+     * You can configure the aspect of your header document using the following values.
+     */
+    header: {
+        /**
+         * Element to add in the header part of the document. You can use variables... Don't forget to escape these in template so they are not interpreted as Handlebars variables, eg. \{{page}}
+         * {{date}}	Formatted print date
+         * {{title}}	Title of the HTML document
+         * {{url}}	Page URL
+         * {{page}}	Current page
+         * {{total}}	Total number of pages
+         */
+        html: StoredTemplate | Template;
+        /**
+         * A spacing between the footer and the content.
+         * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+         */
+        height: PdfUnitValue;
+        /**
+         * Start to display the header/footer at that given page. Important: If you send header AND footer, and set a start_at higher than 1, it must be the same for header and footer.
+         */
+        startAt: number;
+    };
+    /**
+     * You can configure the aspect of your footer document using the following values.
+     */
+    footer: {
+        /**
+         * Element to add in the footer part of the document. You can use variables... Don't forget to escape these in template so they are not interpreted as Handlebars variables, eg. \{{page}}
+         * {{date}}	Formatted print date
+         * {{title}}	Title of the HTML document
+         * {{url}}	Page URL
+         * {{page}}	Current page
+         * {{total}}	Total number of pages
+         */
+        html: StoredTemplate | Template;
+        /**
+         * A spacing between the footer and the content.
+         * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+         */
+        height: PdfUnitValue;
+        /**
+         * Start to display the header/footer at that given page. Important: If you send header AND footer, and set a start_at higher than 1, it must be the same for header and footer.
+         */
+        startAt: number;
+    };
+}
+export declare const GeneratePdfTask: z.ZodType<GeneratePdfTask>;
+export declare const validateGeneratePdfTask: (task: GeneratePdfTask, resources: FinalizeTaskResource[]) => void;
+/**
+ * Text watermark stamped onto every page. Maps to PdfShift's text-mode `watermark` payload.
+ * All styling fields are optional; PdfShift applies its own defaults when omitted.
+ */
+export interface PdfTextWatermark {
+    kind: 'text';
+    /** Watermark text. */
+    text: string;
+    /** Font size in pixels. */
+    fontSize?: number;
+    /** Font family, e.g. `Helvetica`. */
+    fontFamily?: string;
+    /** Text color as a bare hex string without the leading `#`, e.g. `ff0000`. */
+    color?: string;
+    /** Opacity as a percentage, 0–100. */
+    opacity?: number;
+    bold?: boolean;
+    italic?: boolean;
+    /** Horizontal placement — `left`/`center`/`right` or a numeric value with a unit (`px`, `cm`, `mm`, `in`, `pt`). */
+    offsetX?: string;
+    /** Vertical placement — `top`/`middle`/`bottom` or a numeric value with a unit (`px`, `cm`, `mm`, `in`, `pt`). */
+    offsetY?: string;
+    /** Rotation in degrees. */
+    rotate?: number;
+}
+/**
+ * Image watermark stamped onto every page. Maps to PdfShift's image-mode `watermark` payload.
+ * PdfShift supports only positioning/rotation for images — no opacity or styling.
+ */
+export interface PdfImageWatermark {
+    kind: 'image';
+    /**
+     * Image source. May be a public URL, a base64 data URI, or a `configuration-resource://<name>` placeholder
+     * (interpolated to a signed URL before rendering — the referenced resource must be in `includeResources`).
+     */
+    image: string;
+    /** Horizontal placement — `left`/`center`/`right` or a numeric value with a unit (`px`, `cm`, `mm`, `in`, `pt`). */
+    offsetX?: string;
+    /** Vertical placement — `top`/`middle`/`bottom` or a numeric value with a unit (`px`, `cm`, `mm`, `in`, `pt`). */
+    offsetY?: string;
+    /** Rotation in degrees. */
+    rotate?: number;
+}
+/**
+ * A single watermark applied to all pages. PdfShift permits exactly one watermark per document — either text or image.
+ */
+export type PdfWatermark = PdfTextWatermark | PdfImageWatermark;
+export interface GenerateStaticPdfTask {
+    type: typeof TaskType.GenerateStaticPdf;
+    /**
+     * The name of the pdf file
+     */
+    name: string;
+    /**
+     * Body HTML for the PDF.
+     *
+     * `configuration-resource://<name>` occurrences are replaced with the resource value before rendering.
+     * The referenced resource must be listed in `includeResources`.
+     *
+     * PdfShift template macros (`{{page}}`, `{{total}}`, `{{date}}`, `{{title}}`, `{{url}}`) pass through unchanged
+     * and are resolved by PdfShift at render time.
+     */
+    html: string;
+    /**
+     * Format of the document. You can either use the standard values (Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5)
+     * or a custom {width}x{height} value. For {width} and {height}, you can indicate the following units: in, cm, mm.
+     */
+    format?: string;
+    /**
+     * Margin between the document limits and content.
+     * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+     */
+    margin: {
+        top: PdfUnitValue;
+        right: PdfUnitValue;
+        bottom: PdfUnitValue;
+        left: PdfUnitValue;
+    };
+    /**
+     * Header HTML, height and start page. Use the same `configuration-resource://` placeholder convention as `html`.
+     * Use `height: 0` to omit the header.
+     * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+     */
+    header: {
+        html: string;
+        height: PdfUnitValue;
+        startAt: number;
+    };
+    /**
+     * Footer HTML, height and start page. Use the same `configuration-resource://` placeholder convention as `html`.
+     * Use `height: 0` to omit the footer.
+     * Use strings to specify the units, e.g. "10cm" or "10in". Numbers are interpreted as pixels.
+     */
+    footer: {
+        html: string;
+        height: PdfUnitValue;
+        startAt: number;
+    };
+    /**
+     * Resources referenced by `configuration-resource://<name>` placeholders across body, header and footer.
+     */
+    includeResources: readonly TemplateResource[];
+    /**
+     * Optional watermark applied to every page. An image watermark may reference a resource via the
+     * `configuration-resource://<name>` placeholder convention (the resource must be in `includeResources`).
+     */
+    watermark?: PdfWatermark;
+}
+export declare const GenerateStaticPdfTask: z.ZodType<GenerateStaticPdfTask>;
+export declare const validateGenerateStaticPdfTask: (task: GenerateStaticPdfTask, resources: FinalizeTaskResource[]) => void;

package/dist/webhook/tasks/generate-pdf-task.js

@@ -0,0 +1 @@
+import{z as t}from"zod";import{StoredTemplate as e,TaskType as n,Template as o,TemplateResource as i,validateTemplate as a}from"../core/index.js";export const PdfUnitValueSchema=t.union([t.number(),t.string().regex(/^-?\d+(\.\d+)?(px|cm|mm|in|pt)$/)]);export const GeneratePdfTask=t.object({type:t.literal(n.GeneratePdf),name:t.string(),html:t.union([e,o]),format:t.string().optional(),margin:t.object({top:PdfUnitValueSchema,right:PdfUnitValueSchema,bottom:PdfUnitValueSchema,left:PdfUnitValueSchema}),header:t.object({html:t.union([e,o]),height:PdfUnitValueSchema,startAt:t.number()}),footer:t.object({html:t.union([e,o]),height:PdfUnitValueSchema,startAt:t.number()})});export const validateGeneratePdfTask=(t,e)=>{a(t.html,e),a(t.header.html,e),a(t.footer.html,e)};let r=t.discriminatedUnion("kind",[t.object({kind:t.literal("text"),text:t.string(),fontSize:t.number().optional(),fontFamily:t.string().optional(),color:t.string().optional(),opacity:t.number().optional(),bold:t.boolean().optional(),italic:t.boolean().optional(),offsetX:t.string().optional(),offsetY:t.string().optional(),rotate:t.number().optional()}),t.object({kind:t.literal("image"),image:t.string(),offsetX:t.string().optional(),offsetY:t.string().optional(),rotate:t.number().optional()})]);export const GenerateStaticPdfTask=t.object({type:t.literal(n.GenerateStaticPdf),name:t.string(),html:t.string(),format:t.string().optional(),margin:t.object({top:PdfUnitValueSchema,right:PdfUnitValueSchema,bottom:PdfUnitValueSchema,left:PdfUnitValueSchema}),header:t.object({html:t.string(),height:PdfUnitValueSchema,startAt:t.number()}),footer:t.object({html:t.string(),height:PdfUnitValueSchema,startAt:t.number()}),includeResources:t.array(i),watermark:r.optional()});export const validateGenerateStaticPdfTask=(t,e)=>{t.includeResources.forEach(t=>{if(null==e.find(e=>e.name===t.name))throw Error(`The provided FinalizeTask configuration is invalid! Static PDF includeResources references "${t.name}" which is not declared in the resources. Declare it or remove the reference.`)})};

package/dist/webhook/tasks/index.d.ts

@@ -0,0 +1,13 @@
+export { GenerateConfigurationLinkTask } from './generate-configuration-link-task.js';
+export { type PdfUnitValue, type PdfWatermark, type PdfTextWatermark, type PdfImageWatermark, PdfUnitValueSchema, GeneratePdfTask, GenerateStaticPdfTask, validateGeneratePdfTask, validateGenerateStaticPdfTask, } from './generate-pdf-task.js';
+export { GenerateCsvTask } from './generate-csv-task.js';
+export { SendEmailTask, SendStaticEmailTask, EmailAttachment, Base64EmailAttachment, ResourceEmailAttachment, validateSendEmailTask, validateSendStaticEmailTask, } from './send-email-task.js';
+export { SendHttpRequestTask } from './send-http-task.js';
+export { WooCommerceAddToCartItem, WooCommerceAddToCartResource, WooCommerceAddToCartTask, WooCommerceAddToCartFee, WooCommerceAddToCartFeeType, } from './woocommerce-add-to-cart-task.js';
+export { PublishRevisionTask, createPublishRevisionTask } from './publish-revision-task.js';
+export { type ChunkDefinition, PublishRevisionChunksTask, createPublishRevisionChunksTask, } from './publish-revision-chunks-task.js';
+export { PublishRevisionChunksStagedData, PublishRevisionChunksStagedTask, createPublishRevisionChunksStagedTask, } from './publish-revision-chunks-staged-task.js';
+export { CallLambdaBackResourceType, CallLambdaBackResource, CallLambdaBackTask, validateCallLambdaBackTask, } from './call-lambda-back-task.js';
+export { type BlenderMaterialOverride, BlenderMaterialOverrideSchema, type BlenderLight, type BlenderRenderSettings, type BlenderCameraDof, GenerateImagesTask, RenderedEntity, CustomRenderedEntity, DefaultRenderedEntity, } from './generate-images-task.js';
+export { EditGoogleSpreadsheetTask, GoogleSpreadsheetEdit, GoogleSpreadsheetCellValue, GoogleSpreadsheetReference, GoogleSpreadsheetEditMode, } from './edit-google-spreadsheet-task.js';
+export { WebhookFinalizeTaskConfiguration, type WebhookFinalizeTask, validateTaskConfiguration, } from './finalize-task.js';

package/dist/webhook/tasks/index.js

@@ -0,0 +1 @@
+export{GenerateConfigurationLinkTask}from"./generate-configuration-link-task.js";export{PdfUnitValueSchema,GeneratePdfTask,GenerateStaticPdfTask,validateGeneratePdfTask,validateGenerateStaticPdfTask}from"./generate-pdf-task.js";export{GenerateCsvTask}from"./generate-csv-task.js";export{SendEmailTask,SendStaticEmailTask,EmailAttachment,Base64EmailAttachment,ResourceEmailAttachment,validateSendEmailTask,validateSendStaticEmailTask}from"./send-email-task.js";export{SendHttpRequestTask}from"./send-http-task.js";export{WooCommerceAddToCartItem,WooCommerceAddToCartResource,WooCommerceAddToCartTask,WooCommerceAddToCartFee,WooCommerceAddToCartFeeType}from"./woocommerce-add-to-cart-task.js";export{PublishRevisionTask,createPublishRevisionTask}from"./publish-revision-task.js";export{PublishRevisionChunksTask,createPublishRevisionChunksTask}from"./publish-revision-chunks-task.js";export{PublishRevisionChunksStagedData,PublishRevisionChunksStagedTask,createPublishRevisionChunksStagedTask}from"./publish-revision-chunks-staged-task.js";export{CallLambdaBackResourceType,CallLambdaBackResource,CallLambdaBackTask,validateCallLambdaBackTask}from"./call-lambda-back-task.js";export{BlenderMaterialOverrideSchema,GenerateImagesTask,RenderedEntity,CustomRenderedEntity,DefaultRenderedEntity}from"./generate-images-task.js";export{EditGoogleSpreadsheetTask,GoogleSpreadsheetEdit,GoogleSpreadsheetCellValue,GoogleSpreadsheetReference,GoogleSpreadsheetEditMode}from"./edit-google-spreadsheet-task.js";export{WebhookFinalizeTaskConfiguration,validateTaskConfiguration}from"./finalize-task.js";