bannerify-js 0.0.12 → 0.0.15

package/dist/index.d.cts

@@ -1,5 +1,4 @@
 import { ChartData } from 'chart.js';
-export { HTTPError, TimeoutError } from 'ky';
 
 type Modification = {
     name: string;
@@ -75,26 +74,406 @@ type Modification = {
     visible?: boolean;
 };
 
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+
+interface paths {
+  "/v1/liveness": {
+    get: {
+      responses: {
+        /** @description The configured services and their status */
+        200: {
+          content: {
+            "application/json": {
+              /** @description The status of the server */
+              status: string;
+            };
+          };
+        };
+        /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+        400: {
+          content: {
+            "application/json": components["schemas"]["ErrBadRequest"];
+          };
+        };
+        /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrUnauthorized"];
+          };
+        };
+        /** @description The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrForbidden"];
+          };
+        };
+        /** @description The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web. */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrNotFound"];
+          };
+        };
+        /** @description This response is sent when a request conflicts with the current state of the server. */
+        409: {
+          content: {
+            "application/json": components["schemas"]["ErrConflict"];
+          };
+        };
+        /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
+        429: {
+          content: {
+            "application/json": components["schemas"]["ErrTooManyRequests"];
+          };
+        };
+        /** @description The server has encountered a situation it does not know how to handle. */
+        500: {
+          content: {
+            "application/json": components["schemas"]["ErrInternalServerError"];
+          };
+        };
+      };
+    };
+  };
+  "/v1/templates/createImage": {
+    get: {
+      parameters: {
+        query: {
+          modifications?: string;
+          format?: "png" | "svg";
+          nocache?: string;
+          _debug?: string;
+          apiKey: string;
+          templateId: string;
+        };
+      };
+      responses: {
+        /** @description A image file */
+        200: {
+          content: {
+            "image/png": unknown;
+            "image/svg+xml": string;
+          };
+        };
+        /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+        400: {
+          content: {
+            "application/json": components["schemas"]["ErrBadRequest"];
+          };
+        };
+        /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrUnauthorized"];
+          };
+        };
+        /** @description The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrForbidden"];
+          };
+        };
+        /** @description The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web. */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrNotFound"];
+          };
+        };
+        /** @description This response is sent when a request conflicts with the current state of the server. */
+        409: {
+          content: {
+            "application/json": components["schemas"]["ErrConflict"];
+          };
+        };
+        /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
+        429: {
+          content: {
+            "application/json": components["schemas"]["ErrTooManyRequests"];
+          };
+        };
+        /** @description The server has encountered a situation it does not know how to handle. */
+        500: {
+          content: {
+            "application/json": components["schemas"]["ErrInternalServerError"];
+          };
+        };
+      };
+    };
+  };
+  "/v1/templates/imageSignedUrl": {
+    get: {
+      parameters: {
+        query: {
+          modifications?: string;
+          format?: "png" | "svg";
+          nocache?: string;
+          _debug?: string;
+          templateId: string;
+          apiKeyMd5: string;
+          sign: string;
+        };
+      };
+      responses: {
+        /** @description A image file */
+        200: {
+          content: {
+            "image/png": unknown;
+          };
+        };
+        /** @description The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). */
+        400: {
+          content: {
+            "application/json": components["schemas"]["ErrBadRequest"];
+          };
+        };
+        /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
+        401: {
+          content: {
+            "application/json": components["schemas"]["ErrUnauthorized"];
+          };
+        };
+        /** @description The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. */
+        403: {
+          content: {
+            "application/json": components["schemas"]["ErrForbidden"];
+          };
+        };
+        /** @description The server cannot find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 Forbidden to hide the existence of a resource from an unauthorized client. This response code is probably the most well known due to its frequent occurrence on the web. */
+        404: {
+          content: {
+            "application/json": components["schemas"]["ErrNotFound"];
+          };
+        };
+        /** @description This response is sent when a request conflicts with the current state of the server. */
+        409: {
+          content: {
+            "application/json": components["schemas"]["ErrConflict"];
+          };
+        };
+        /** @description The user has sent too many requests in a given amount of time ("rate limiting") */
+        429: {
+          content: {
+            "application/json": components["schemas"]["ErrTooManyRequests"];
+          };
+        };
+        /** @description The server has encountered a situation it does not know how to handle. */
+        500: {
+          content: {
+            "application/json": components["schemas"]["ErrInternalServerError"];
+          };
+        };
+      };
+    };
+  };
+}
+
+interface components {
+  schemas: {
+    ErrBadRequest: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example BAD_REQUEST
+         * @enum {string}
+         */
+        code: "BAD_REQUEST";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/BAD_REQUEST
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrUnauthorized: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example UNAUTHORIZED
+         * @enum {string}
+         */
+        code: "UNAUTHORIZED";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/UNAUTHORIZED
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrForbidden: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example FORBIDDEN
+         * @enum {string}
+         */
+        code: "FORBIDDEN";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/FORBIDDEN
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrNotFound: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example NOT_FOUND
+         * @enum {string}
+         */
+        code: "NOT_FOUND";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/NOT_FOUND
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrConflict: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example CONFLICT
+         * @enum {string}
+         */
+        code: "CONFLICT";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/CONFLICT
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrTooManyRequests: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example TOO_MANY_REQUESTS
+         * @enum {string}
+         */
+        code: "TOO_MANY_REQUESTS";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/TOO_MANY_REQUESTS
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+    ErrInternalServerError: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example INTERNAL_SERVER_ERROR
+         * @enum {string}
+         */
+        code: "INTERNAL_SERVER_ERROR";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/INTERNAL_SERVER_ERROR
+         */
+        docs: string;
+        /** @description A human readable explanation of what went wrong */
+        message: string;
+        /**
+         * @description Please always include the requestId in your error report
+         * @example req:1234
+         */
+        requestId: string;
+      };
+    };
+  };
+  responses: never;
+  parameters: {
+  };
+  requestBodies: never;
+  headers: never;
+  pathItems: never;
+}
+
+type codes = '400' | '401' | '403' | '404' | '500';
+type ErrorResponse = paths['/v1/liveness']['get']['responses'][codes]['content']['application/json'];
+declare const timeoutError: {
+    error: {
+        code: string;
+        message: string;
+        docs: string;
+        requestId: string;
+    };
+};
+type Result<R> = {
+    result: R;
+    error?: never;
+} | {
+    result?: never;
+    error: ErrorResponse['error'] | typeof timeoutError;
+};
+
 interface Options {
     apiKey: string;
     fetch?: typeof fetch;
     baseUrl?: string;
+    timeout?: number;
 }
 type CreateOptions = {
     modifications?: Modification[];
     container?: Modification;
     format?: 'svg' | 'png';
-    timeout?: number;
 };
-declare function createClient(opts: Options): Bannerify;
+declare function createClient(apiKey: string, opts?: Options): Bannerify;
 declare class Bannerify {
     #private;
-    private readonly opts;
+    private readonly apiKey;
+    private readonly opts?;
     private readonly client;
     private readonly baseUrl;
-    constructor(opts: Options);
-    createImage(templateId: string, options?: CreateOptions): Promise<string | ArrayBuffer>;
-    createPdf(templateId: string, options?: CreateOptions): Promise<ArrayBuffer>;
+    constructor(apiKey: string, opts?: Options | undefined);
+    createImage(templateId: string, options?: CreateOptions): Promise<Result<ArrayBuffer | string>>;
+    createPdf(templateId: string, options?: CreateOptions): Promise<void>;
     createPermanentImage(): Promise<void>;
     generateImageSignedUrl(templateId: string, options?: CreateOptions): Promise<string>;
 }