@doczilla/node - npm Package Compare versions

Comparing version 1.5.2 to 1.6.0

CHANGELOG.md

@@ -1,9 +0,4 @@
-## [1.5.2](https://github.com/doczilla-app/doczilla-node/compare/v1.5.1...v1.5.2) (2024-07-17)
+# [1.6.0](https://github.com/doczilla-app/doczilla-node/compare/v1.5.2...v1.6.0) (2024-07-31)
 
 
-### Bug Fixes
-
-* Don't include test files in dist ([8069309](https://github.com/doczilla-app/doczilla-node/commit/806930973c3c1fe1a0d8fe5ee213dddcdeb1ecdf))
-
-
 ### Features
@@ -13,4 +8,5 @@
 * Added support for PDF `tagged` option ([8d0c993](https://github.com/doczilla-app/doczilla-node/commit/8d0c9930cdf0fc1d9f412d14f1f352ea93d34ce0))
+* Updated models with new accepted page options ([0e25786](https://github.com/doczilla-app/doczilla-node/commit/0e25786687fa9fa129476da6cd4594dbf1612935))
 
 
 

dist/types/generated/index.d.ts

@@ -12,2 +12,6 @@ export { AsyncJob } from './models/AsyncJob';
 export { PageOptions } from './models/PageOptions';
+export type { PageWaitForFunction } from './models/PageWaitForFunction';
+export type { PageWaitForFunctionOptions } from './models/PageWaitForFunctionOptions';
+export type { PageWaitForSelector } from './models/PageWaitForSelector';
+export type { PageWaitForSelectorOptions } from './models/PageWaitForSelectorOptions';
 export type { PayloadTooLargeResponse } from './models/PayloadTooLargeResponse';
@@ -14,0 +18,0 @@ export type { PDFMargin } from './models/PDFMargin';

dist/types/generated/models/PageCookie.d.ts

@@ -15,3 +15,3 @@ export type PageCookie = {
     /**
-     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
+     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`
      */
@@ -18,0 +18,0 @@ url?: string | null;

dist/types/generated/models/PageOptions.d.ts

 import type { PageAuthentication } from './PageAuthentication';
 import type { PageCookie } from './PageCookie';
+import type { PageWaitForFunction } from './PageWaitForFunction';
+import type { PageWaitForSelector } from './PageWaitForSelector';
 export type PageOptions = {
     /**
-     * URL to go to.
+     * URL to go to. Should include the scheme, e.g. `https://`
      */
@@ -30,2 +32,14 @@ url?: string | null;
     /**
+     * Wait for a certain amount of milliseconds before the request continues.
+     */
+    waitForMilliseconds?: number | null;
+    /**
+     * Wait for the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) to appear in page. If the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) doesn't appear after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForSelector?: PageWaitForSelector | null;
+    /**
+     * Wait for the `pageFunction` to execute in the page. If the `pageFunction` doesn't execute successfully after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForFunction?: PageWaitForFunction | null;
+    /**
      * An object containing additional HTTP headers to be sent with every request. All header values must be strings.
@@ -32,0 +46,0 @@ */

dist/types/generated/models/PdfOptions.d.ts

@@ -74,3 +74,3 @@ import type { PDFMargin } from './PDFMargin';
      * Generate document outline.
-     * If this is enabled the PDF will also be tagged (accessible)
+     * If this is enabled the PDF will also be tagged (accessible).
      */
@@ -77,0 +77,0 @@ outline?: boolean;

dist/types/generated/models/ScreenshotOptions.d.ts

@@ -40,3 +40,3 @@ import type { ScreenshotClip } from './ScreenshotClip';
     /**
-     * It captures the DOM element matching the given CSS selector. This will overwrite the `clip` property and set `fullPage` to `false`.
+     * It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`.
      */
@@ -43,0 +43,0 @@ element?: string | null;

dist/types/generated/models/StorageOptions.d.ts

 export type StorageOptions = {
     /**
-     * Pre-signed url to upload the generated pdf/screenshot to.
+     * Pre-signed url to upload the generated pdf/screenshot to. Should include the scheme, e.g. `https://`
      */
     preSignedUrl: string;
 };

dist/types/generated/models/SyncJob.d.ts

@@ -11,3 +11,3 @@ export type SyncJob = {
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
@@ -14,0 +14,0 @@ fileUrl?: string | null;

dist/types/generated/models/WebhookEvent.d.ts

@@ -11,3 +11,3 @@ export type WebhookEvent = {
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
@@ -23,3 +23,3 @@ fileUrl?: string | null;
     /**
-     * The generated file base64 encoded (will be null if `storage.signedUrl` is used).
+     * The generated file base64 encoded (will be `null` if `storage.signedUrl` is used).
      */
@@ -26,0 +26,0 @@ fileBase64?: string | null;

dist/types/generated/models/WebhookOptions.d.ts

@@ -9,3 +9,3 @@ export type WebhookOptions = {
     /**
-     * The webhook's URL.
+     * The webhook's URL. Should include the scheme, e.g. `https://`
      */
@@ -12,0 +12,0 @@ url: string;

package.json

@@ -1,1 +0,1 @@
-{"name":"@doczilla/node","version":"1.5.2","description":"Doczilla API wrapper","keywords":["doczilla","puppeteer","html2pdf","html2image","api","chrome","headless"],"homepage":"https://github.com/doczilla-app/doczilla-node","bugs":{"url":"https://github.com/doczilla-app/doczilla-node/issues"},"repository":{"type":"git","url":"https://github.com/doczilla-app/doczilla-node.git"},"license":"MIT","author":{"name":"Doczilla","email":"[e-mail]","url":"https://doczilla.app"},"sideEffects":false,"exports":{".":{"require":"./dist/index.js","import":"./dist/index.mjs","types":"./dist/types/index.d.ts"},"./package.json":"./package.json"},"main":"./dist/index.js","module":"./dist/esm/index.js","types":"./dist/types/index.d.ts","scripts":{"build":"yarn clean && yarn build:ts && yarn build:types","build:ts":"tsup src/index.ts --format cjs,esm --clean","build:types":"tsc --emitDeclarationOnly --outDir dist/types","clean":"rm -rf dist","generate:sdk":"node ./generate-models.js && yarn build","lint":"eslint --ext .ts .","test":"jest"},"dependencies":{"axios":"^1.7.2"},"devDependencies":{"@jest/globals":"^29.7.0","@swc/core":"^1.6.13","@types/jest":"^29.5.12","@types/node":"^20.14.10","@typescript-eslint/eslint-plugin":"^7.16.1","@typescript-eslint/parser":"^7.16.1","axios-mock-adapter":"^1.22.0","eslint":"9.7.0","eslint-plugin-import":"2.29.1","eslint-plugin-simple-import-sort":"^12.1.1","jest":"^29.7.0","openapi-typescript-codegen":"^0.29.0","ts-jest":"^29.2.2","tsup":"^8.1.1","typescript":"^5.5"},"packageManager":"yarn@4.2.2","engines":{"node":">=18.*"}}
+{"name":"@doczilla/node","version":"1.6.0","description":"Doczilla API wrapper","keywords":["doczilla","puppeteer","html2pdf","html2image","api","chrome","headless"],"homepage":"https://github.com/doczilla-app/doczilla-node","bugs":{"url":"https://github.com/doczilla-app/doczilla-node/issues"},"repository":{"type":"git","url":"https://github.com/doczilla-app/doczilla-node.git"},"license":"MIT","author":{"name":"Doczilla","email":"[e-mail]","url":"https://doczilla.app"},"sideEffects":false,"exports":{".":{"require":"./dist/index.js","import":"./dist/index.mjs","types":"./dist/types/index.d.ts"},"./package.json":"./package.json"},"main":"./dist/index.js","module":"./dist/esm/index.js","types":"./dist/types/index.d.ts","scripts":{"build":"yarn clean && yarn build:ts && yarn build:types","build:ts":"tsup src/index.ts --format cjs,esm --clean","build:types":"tsc --emitDeclarationOnly --outDir dist/types","clean":"rm -rf dist","generate:sdk":"node ./generate-models.js && yarn build","lint":"eslint --ext .ts .","test":"jest"},"dependencies":{"axios":"^1.7.2"},"devDependencies":{"@jest/globals":"^29.7.0","@swc/core":"^1.7.3","@types/jest":"^29.5.12","@types/node":"^20.14.10","@typescript-eslint/eslint-plugin":"^7.17.0","@typescript-eslint/parser":"^7.17.0","axios-mock-adapter":"^1.22.0","eslint":"9.8.0","eslint-plugin-import":"2.29.1","eslint-plugin-simple-import-sort":"^12.1.1","jest":"^29.7.0","openapi-typescript-codegen":"^0.29.0","ts-jest":"^29.2.3","tsup":"^8.2.3","typescript":"^5.5"},"packageManager":"yarn@4.2.2","engines":{"node":">=18.*"}}

src/generated/index.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -17,2 +17,6 @@ /* tslint:disable */
 export { PageOptions } from './models/PageOptions';
+export type { PageWaitForFunction } from './models/PageWaitForFunction';
+export type { PageWaitForFunctionOptions } from './models/PageWaitForFunctionOptions';
+export type { PageWaitForSelector } from './models/PageWaitForSelector';
+export type { PageWaitForSelectorOptions } from './models/PageWaitForSelectorOptions';
 export type { PayloadTooLargeResponse } from './models/PayloadTooLargeResponse';
@@ -19,0 +23,0 @@ export type { PDFMargin } from './models/PDFMargin';

src/generated/models/AsyncJob.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/AsyncPdf.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/AsyncScreenshot.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/BadRequestResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/CreatePdf.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/CreateScreenshot.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/ForbiddenResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/InternalServerErrorResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/PageAuthentication.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/PageCookie.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -19,3 +19,3 @@ /* tslint:disable */
     /**
-     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie.
+     * The request-URI to associate with the setting of the cookie. This value can affect the default domain, path, source port, and source scheme values of the created cookie. Should include the scheme, e.g. `https://`
      */
@@ -22,0 +22,0 @@ url?: string | null;

src/generated/models/PageOptions.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -7,5 +7,7 @@ /* tslint:disable */
 import type { PageCookie } from './PageCookie';
+import type { PageWaitForFunction } from './PageWaitForFunction';
+import type { PageWaitForSelector } from './PageWaitForSelector';
 export type PageOptions = {
     /**
-     * URL to go to.
+     * URL to go to. Should include the scheme, e.g. `https://`
      */
@@ -35,2 +37,14 @@ url?: string | null;
     /**
+     * Wait for a certain amount of milliseconds before the request continues.
+     */
+    waitForMilliseconds?: number | null;
+    /**
+     * Wait for the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) to appear in page. If the [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors) doesn't appear after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForSelector?: PageWaitForSelector | null;
+    /**
+     * Wait for the `pageFunction` to execute in the page. If the `pageFunction` doesn't execute successfully after the `timeout` milliseconds of waiting, the request will continue.
+     */
+    waitForFunction?: PageWaitForFunction | null;
+    /**
      * An object containing additional HTTP headers to be sent with every request. All header values must be strings.
@@ -37,0 +51,0 @@ */

src/generated/models/PayloadTooLargeResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/PDFMargin.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/PdfOptions.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -78,3 +78,3 @@ /* tslint:disable */
      * Generate document outline.
-     * If this is enabled the PDF will also be tagged (accessible)
+     * If this is enabled the PDF will also be tagged (accessible).
      */
@@ -81,0 +81,0 @@ outline?: boolean;

src/generated/models/ScreenshotClip.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/ScreenshotOptions.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -44,3 +44,3 @@ /* tslint:disable */
     /**
-     * It captures the DOM element matching the given CSS selector. This will overwrite the `clip` property and set `fullPage` to `false`.
+     * It captures the DOM element matching the given CSS [selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_selectors). This will overwrite the `clip` property and set `fullPage` to `false`.
      */
@@ -47,0 +47,0 @@ element?: string | null;

src/generated/models/ScreenshotOverlay.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/ScreenshotViewport.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/StorageOptions.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -7,3 +7,3 @@ /* tslint:disable */
     /**
-     * Pre-signed url to upload the generated pdf/screenshot to.
+     * Pre-signed url to upload the generated pdf/screenshot to. Should include the scheme, e.g. `https://`
      */
@@ -10,0 +10,0 @@ preSignedUrl: string;

src/generated/models/SubscriptionLimitReachedResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/SyncJob.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -15,3 +15,3 @@ /* tslint:disable */
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
@@ -18,0 +18,0 @@ fileUrl?: string | null;

src/generated/models/SyncPdf.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/SyncScreenshot.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/TooManyRequestsResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/UnauthorizedResponse.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -3,0 +3,0 @@ /* tslint:disable */

src/generated/models/WebhookEvent.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -15,3 +15,3 @@ /* tslint:disable */
     /**
-     * URL to the generated file (will be null if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
+     * URL to the generated file (will be `null` if `storage.signedUrl` is used). This url is valid for 1 hour, after that the file will be deleted from our storage.
      */
@@ -27,3 +27,3 @@ fileUrl?: string | null;
     /**
-     * The generated file base64 encoded (will be null if `storage.signedUrl` is used).
+     * The generated file base64 encoded (will be `null` if `storage.signedUrl` is used).
      */
@@ -30,0 +30,0 @@ fileBase64?: string | null;

src/generated/models/WebhookOptions.ts

@@ -1,2 +0,2 @@
-/* generated using openapi-typescript-codegen -- do no edit */
+/* generated using openapi-typescript-codegen -- do not edit */
 /* istanbul ignore file */
@@ -13,3 +13,3 @@ /* tslint:disable */
     /**
-     * The webhook's URL.
+     * The webhook's URL. Should include the scheme, e.g. `https://`
      */
@@ -16,0 +16,0 @@ url: string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

117601

increased by8.13%

Number of package files

89

increased by9.88%

Lines of code

3192

increased by5.28%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes