@html-css-to-image/client 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -133,7 +133,7 @@ export class HtmlCssToImageClient {
133
133
  const params = new URLSearchParams();
134
134
  params.append('url', request.url);
135
135
  Object.entries(request)
136
- .filter(([key, _]) => key !== 'url' && key !== 'format' && key != 'pdf_options' && key !== 'dedupe_duration_s' && key !== '__type')
136
+ .filter(([key, _]) => key !== 'url' && key !== 'format' && key != 'pdf_options' && key !== 'dedupe_duration_s' && key !== 'request_overrides' && key !== '__type')
137
137
  .sort((a, b) => a[0].localeCompare(b[0]))
138
138
  .forEach(([key, value]) => {
139
139
  if (value !== undefined && value !== null && (value !== false || key === 'transparent_background')) {
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- export { BaseCreateImageRequest, CreateHtmlCssImageRequest, CreateTemplatedImageRequest, CreateUrlImageRequest, PDFOptions } from './types/request.js';
2
- export type { ColorSchemeType, MediaType, PdfMargins, PdfValueInput, PdfValueWithUnits, PdfUnit, RenderImageFormat } from './types/request.js';
1
+ export { BaseCreateImageRequest, CreateHtmlCssImageRequest, CreateTemplatedImageRequest, CreateUrlImageRequest, PDFOptions, RequestOverrideAction, RequestOverrideResourceType } from './types/request.js';
2
+ export type { ColorSchemeType, MediaType, PdfMargins, PdfValueInput, PdfValueWithUnits, PdfUnit, RenderImageFormat, RequestOverride } from './types/request.js';
3
3
  export type { CreateImageBatchResponse, CreateImageBatchSuccessResponse, CreateImageErrorResponse, CreateImageResponse, CreateImageSuccessResponse, DeleteImageResponse, DeleteImageSuccessResponse, ValidationError } from './types/response.js';
4
4
  export { HtmlCssToImageClient } from './HtmlCssToImageClient.js';
5
5
  export type { FetchFunction } from './HtmlCssToImageClient.js';
package/dist/index.js CHANGED
@@ -1,2 +1,2 @@
1
- export { BaseCreateImageRequest, CreateHtmlCssImageRequest, CreateTemplatedImageRequest, CreateUrlImageRequest, PDFOptions } from './types/request.js';
1
+ export { BaseCreateImageRequest, CreateHtmlCssImageRequest, CreateTemplatedImageRequest, CreateUrlImageRequest, PDFOptions, RequestOverrideAction, RequestOverrideResourceType } from './types/request.js';
2
2
  export { HtmlCssToImageClient } from './HtmlCssToImageClient.js';
@@ -2,6 +2,32 @@ export type ColorSchemeType = 'light' | 'dark';
2
2
  export type PdfUnit = 'px' | 'in' | 'cm' | 'mm';
3
3
  export type MediaType = 'print' | 'screen';
4
4
  export type RenderImageFormat = 'png' | 'jpg' | 'webp' | 'pdf';
5
+ export declare enum RequestOverrideResourceType {
6
+ Beacon = "beacon",
7
+ Document = "document",
8
+ Stylesheet = "stylesheet",
9
+ Image = "image",
10
+ ImageSet = "image_set",
11
+ Media = "media",
12
+ Font = "font",
13
+ Script = "script",
14
+ TextTrack = "text_track",
15
+ Xhr = "xhr",
16
+ Fetch = "fetch",
17
+ EventSource = "event_source",
18
+ Manifest = "manifest",
19
+ Ping = "ping",
20
+ Img = "img",
21
+ Other = "other"
22
+ }
23
+ export declare enum RequestOverrideAction {
24
+ Block = "block"
25
+ }
26
+ export interface RequestOverride {
27
+ action: RequestOverrideAction.Block;
28
+ url?: string;
29
+ resource_types?: RequestOverrideResourceType[];
30
+ }
5
31
  export interface PdfValueWithUnits {
6
32
  value: number;
7
33
  unit: PdfUnit;
@@ -100,7 +126,7 @@ export declare abstract class BaseCreateImageRequest {
100
126
  */
101
127
  dedupe_duration_s?: number;
102
128
  /**
103
- * Disable Twemoji fallback rendering.
129
+ * HTML/CSS images use Twemoji by default; true disables it. URL images inject Twemoji only when explicitly false; omission or true leaves the page's emoji handling unchanged.
104
130
  */
105
131
  disable_twemoji?: boolean;
106
132
  /**
@@ -131,6 +157,8 @@ export declare abstract class BaseCreateImageRequest {
131
157
  * Select an organization proxy for rendering.
132
158
  */
133
159
  proxy_id?: string;
160
+ /** Block matching browser network requests. Requires a paid plan. */
161
+ request_overrides?: RequestOverride[];
134
162
  /**
135
163
  * Save rendered images to one of the organization's configured storage destinations.
136
164
  */
@@ -1,3 +1,26 @@
1
+ export var RequestOverrideResourceType;
2
+ (function (RequestOverrideResourceType) {
3
+ RequestOverrideResourceType["Beacon"] = "beacon";
4
+ RequestOverrideResourceType["Document"] = "document";
5
+ RequestOverrideResourceType["Stylesheet"] = "stylesheet";
6
+ RequestOverrideResourceType["Image"] = "image";
7
+ RequestOverrideResourceType["ImageSet"] = "image_set";
8
+ RequestOverrideResourceType["Media"] = "media";
9
+ RequestOverrideResourceType["Font"] = "font";
10
+ RequestOverrideResourceType["Script"] = "script";
11
+ RequestOverrideResourceType["TextTrack"] = "text_track";
12
+ RequestOverrideResourceType["Xhr"] = "xhr";
13
+ RequestOverrideResourceType["Fetch"] = "fetch";
14
+ RequestOverrideResourceType["EventSource"] = "event_source";
15
+ RequestOverrideResourceType["Manifest"] = "manifest";
16
+ RequestOverrideResourceType["Ping"] = "ping";
17
+ RequestOverrideResourceType["Img"] = "img";
18
+ RequestOverrideResourceType["Other"] = "other";
19
+ })(RequestOverrideResourceType || (RequestOverrideResourceType = {}));
20
+ export var RequestOverrideAction;
21
+ (function (RequestOverrideAction) {
22
+ RequestOverrideAction["Block"] = "block";
23
+ })(RequestOverrideAction || (RequestOverrideAction = {}));
1
24
  export class PDFOptions {
2
25
  /**
3
26
  * Whether background graphics should be printed in the PDF output.
@@ -80,7 +103,7 @@ export class BaseCreateImageRequest {
80
103
  */
81
104
  dedupe_duration_s;
82
105
  /**
83
- * Disable Twemoji fallback rendering.
106
+ * HTML/CSS images use Twemoji by default; true disables it. URL images inject Twemoji only when explicitly false; omission or true leaves the page's emoji handling unchanged.
84
107
  */
85
108
  disable_twemoji;
86
109
  /**
@@ -111,6 +134,8 @@ export class BaseCreateImageRequest {
111
134
  * Select an organization proxy for rendering.
112
135
  */
113
136
  proxy_id;
137
+ /** Block matching browser network requests. Requires a paid plan. */
138
+ request_overrides;
114
139
  /**
115
140
  * Save rendered images to one of the organization's configured storage destinations.
116
141
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@html-css-to-image/client",
3
- "version": "0.9.0",
3
+ "version": "0.10.0",
4
4
  "type": "module",
5
5
  "description": "Lightweight TypeScript client for the HTML/CSS to Image API. Generate images from HTML/CSS, URLs, or templates in your TypeScript or JavaScript projects.",
6
6
  "main": "dist/index.js",