Merge pull request #10 from Doczilla-APP/improvements

Improvements

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2023 Doczilla. (https://www.doczilla.app)
+Copyright (C) 2023 Doczilla. (https://doczilla.app)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -13,15 +13,15 @@ yarn add @doczilla/node
 ## Usage
 
 The package needs to be configured with your account's API key, which is
-available your [Doczilla's organisation settings page](https://www.doczilla.app/login).
+available your [Doczilla's organisation settings page](https://doczilla.app/login).
 
 ```ts
 import Doczilla from '@doczilla/node';
 
 const doczilla = new Doczilla('doczilla-...')
 
 const pdfBuffer = await doczilla.pdf.direct({
-  url: 'https://www.doczilla.app'
+  url: 'https://doczilla.app'
 })
 ```
 

package.json

@@ -23,7 +23,7 @@
   "author": {
     "name": "Doczilla",
     "email": "[email protected]",
-    "url": "https://www.doczilla.app"
+    "url": "https://doczilla.app"
   },
   "main": "./dist/index.js",
   "module": "./dist/esm/index.js",
@@ -34,21 +34,21 @@
     "test": "jest"
   },
   "dependencies": {
-    "axios": "^1.6.2"
+    "axios": "^1.6.7"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
     "@types/jest": "^29.5.11",
-    "@types/node": "^20.10.4",
-    "@typescript-eslint/eslint-plugin": "^6.15.0",
-    "@typescript-eslint/parser": "^6.15.0",
+    "@types/node": "^20.11.10",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
     "axios-mock-adapter": "^1.22.0",
     "eslint": "8.56.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-simple-import-sort": "^10.0.0",
     "jest": "^29.7.0",
-    "openapi-typescript-codegen": "^0.25.0",
-    "ts-jest": "^29.1.1",
+    "openapi-typescript-codegen": "^0.27.0",
+    "ts-jest": "^29.1.2",
     "typescript": "^5.3"
   },
   "packageManager": "[email protected]",

src/generated/models/AsyncJob.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type AsyncJob = {
     /**
      * Id of the queued job.
@@ -13,9 +12,7 @@ export type AsyncJob = {
      */
     status: AsyncJob.status;
 };
-
 export namespace AsyncJob {
-
     /**
      * Status of the job.
      */
@@ -25,7 +22,5 @@ export namespace AsyncJob {
         FAILED = 'FAILED',
         COMPLETED = 'COMPLETED',
     }
-
-
 }
 

src/generated/models/AsyncPdf.ts

@@ -2,12 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PageOptions } from './PageOptions';
 import type { PdfOptions } from './PdfOptions';
 import type { StorageOptions } from './StorageOptions';
 import type { WebhookOptions } from './WebhookOptions';
-
 export type AsyncPdf = {
     /**
      * Page options, either provide the `url`, `html` or `htmlTemplate` option.

src/generated/models/AsyncScreenshot.ts

@@ -2,12 +2,10 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PageOptions } from './PageOptions';
 import type { ScreenshotOptions } from './ScreenshotOptions';
 import type { StorageOptions } from './StorageOptions';
 import type { WebhookOptions } from './WebhookOptions';
-
 export type AsyncScreenshot = {
     /**
      * Page options, either provide the `url`, `html` or `htmlTemplate` option.

src/generated/models/BadRequestResponse.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type BadRequestResponse = {
     message: string;
     code: string;

src/generated/models/CreatePdf.ts

@@ -2,10 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PageOptions } from './PageOptions';
 import type { PdfOptions } from './PdfOptions';
-
 export type CreatePdf = {
     /**
      * Page options, either provide the `url`, `html` or `htmlTemplate` option.

src/generated/models/CreateScreenshot.ts

@@ -2,10 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PageOptions } from './PageOptions';
 import type { ScreenshotOptions } from './ScreenshotOptions';
-
 export type CreateScreenshot = {
     /**
      * Page options, either provide the `url`, `html` or `htmlTemplate` option.

src/generated/models/ForbiddenResponse.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type ForbiddenResponse = {
     message: string;
 };

src/generated/models/InternalServerErrorResponse.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type InternalServerErrorResponse = {
     message: string;
 };

src/generated/models/PDFMargin.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type PDFMargin = {
     top?: (string | number) | null;
     bottom?: (string | number) | null;

src/generated/models/PageAuthentication.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type PageAuthentication = {
     username: string;
     password: string;

src/generated/models/PageCookie.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type PageCookie = {
     /**
      * Cookie name.
@@ -41,9 +40,7 @@ export type PageCookie = {
      */
     expires?: number | null;
 };
-
 export namespace PageCookie {
-
     /**
      * Cookie SameSite type.
      */
@@ -52,7 +49,5 @@ export namespace PageCookie {
         LAX = 'Lax',
         NONE = 'None',
     }
-
-
 }
 

src/generated/models/PageOptions.ts

@@ -2,10 +2,8 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PageAuthentication } from './PageAuthentication';
 import type { PageCookie } from './PageCookie';
-
 export type PageOptions = {
     /**
      * URL to go to.
@@ -65,9 +63,7 @@ export type PageOptions = {
      */
     timezone?: string | null;
 };
-
 export namespace PageOptions {
-
     /**
      * When to consider waiting succeeds.
      * - `auto` our smart waiting option that can handle 90% of the cases.
@@ -83,15 +79,12 @@ export namespace PageOptions {
         NETWORKIDLE0 = 'networkidle0',
         NETWORKIDLE2 = 'networkidle2',
     }
-
     /**
      * Changes the CSS media type of the page.
      */
     export enum mediaType {
         SCREEN = 'screen',
         PRINT = 'print',
     }
-
-
 }
 

src/generated/models/PayloadTooLargeResponse.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type PayloadTooLargeResponse = {
     message: string;
 };

src/generated/models/PdfOptions.ts

@@ -2,9 +2,7 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { PDFMargin } from './PDFMargin';
-
 export type PdfOptions = {
     /**
      * Scales the rendering of the web page. Amount must be between `0.1` and `2`.
@@ -76,9 +74,7 @@ export type PdfOptions = {
      */
     omitBackground?: boolean;
 };
-
 export namespace PdfOptions {
-
     /**
      * If set, this takes priority over the `width` and `height` options.
      * The sizes of each format are as follows:
@@ -107,7 +103,5 @@ export namespace PdfOptions {
         A5 = 'a5',
         A6 = 'a6',
     }
-
-
 }
 

src/generated/models/ScreenshotClip.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type ScreenshotClip = {
     scale?: number;
     /**

src/generated/models/ScreenshotOptions.ts

@@ -2,11 +2,9 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 import type { ScreenshotClip } from './ScreenshotClip';
 import type { ScreenshotOverlay } from './ScreenshotOverlay';
 import type { ScreenshotViewport } from './ScreenshotViewport';
-
 export type ScreenshotOptions = {
     type?: ScreenshotOptions.type | null;
     /**
@@ -51,15 +49,12 @@ export type ScreenshotOptions = {
      */
     overlay?: ScreenshotOverlay | null;
 };
-
 export namespace ScreenshotOptions {
-
     export enum type {
         PNG = 'png',
         JPEG = 'jpeg',
         WEBP = 'webp',
     }
-
     /**
      * Device preset to use, will not be set when `viewport` option is provided!
      */
@@ -188,7 +183,5 @@ export namespace ScreenshotOptions {
         I_MAC_27 = 'iMac 27',
         I_MAC_27_5K = 'iMac 27 5K',
     }
-
-
 }
 

src/generated/models/ScreenshotOverlay.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type ScreenshotOverlay = {
     /**
      * Color to apply as background, can be an an hexadecimal/rgb/rgba color code or CSS gradient.
@@ -25,17 +24,13 @@ export type ScreenshotOverlay = {
      */
     screenshotBorderRadius?: number;
 };
-
 export namespace ScreenshotOverlay {
-
     /**
      * Browser to apply.
      */
     export enum browser {
         LIGHT = 'light',
         DARK = 'dark',
     }
-
-
 }
 

src/generated/models/ScreenshotViewport.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type ScreenshotViewport = {
     /**
      * The page width in CSS pixels.

src/generated/models/StorageOptions.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type StorageOptions = {
     /**
      * Pre-signed url to upload the generated pdf/screenshot to.

src/generated/models/SubscriptionLimitReachedResponse.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type SubscriptionLimitReachedResponse = {
     message: string;
 };

src/generated/models/SyncJob.ts

@@ -2,7 +2,6 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-
 export type SyncJob = {
     /**
      * Id of the queued job.
@@ -24,9 +23,7 @@ export type SyncJob = {
      */
     signedUrlStatus?: string | null;
 };
-
 export namespace SyncJob {
-
     /**
      * Status of the job.
      */
@@ -36,7 +33,5 @@ export namespace SyncJob {
         FAILED = 'FAILED',
         COMPLETED = 'COMPLETED',
     }
-
-
 }