bannerify-js 0.0.26 → 0.0.28

package/dist/index.d.ts

@@ -1,79 +1,5 @@
 import { ChartData } from 'chart.js';
 
-type Modification = {
-    name: string;
-    /**
-     * color
-     * @example #FF0000
-     * @default The default color of the layer
-     * @description The color for the modification, accept any valid CSS color value, for example: #FF0000, red, rgba(0,0,0,0.5), etc. You can only modify the color of the text layer with this field.
-     */
-    color?: string;
-    /**
-     * background color
-     * @example #FF0000
-     * @default The default background color of the layer
-     * @description The background color for the modification, accept any valid CSS color value, for example: #FF0000, red, rgba(0,0,0,0.5), etc.
-     */
-    background?: string;
-    /**
-     * font size
-     * @example 12
-     * @default The default font size of the layer
-     * @description The font size for the modification, accept any valid CSS font size value, for example: 12, 12px;
-     */
-    size?: number;
-    /**
-     * source image
-     * @example https://example.com/image.jpg
-     * @default The default source image of the layer
-     * @description The source image for the modification, accept any valid image URL, for example: https://example.com/image.jpg
-     */
-    src?: string;
-    /**
-     * chart data
-     * @example { labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'], datasets: [{ label: 'My First Dataset', data: [65, 59, 80, 81, 56, 55, 40], fill: false, borderColor: 'rgb(75, 192, 192)', tension: 0.1 }] }
-     * @default The default chart data of the layer
-     * @description Update chart layer's data, follow chart.js data structure
-     */
-    chart?: ChartData;
-    /**
-     * text content
-     * @example Hello World
-     * @default The default text content of the layer
-     * @description You can modify the text layer with this field
-     */
-    text?: string;
-    /**
-     * barcode content
-     * @example 1234567890
-     * @default The default barcode content of the layer
-     * @description Modify the barcode layer content with this field
-     */
-    qrcode?: string;
-    /**
-     * qrcode content
-     * @example Some text
-     * @default The default qrcode content of the layer
-     * @description Modify the qrcode layer content with this field
-     */
-    barcode?: string;
-    /**
-     * icon name
-     * @example Menu
-     * @default The default icon name of the layer
-     * @description Modify the icon name with this field
-     */
-    icon?: string;
-    /**
-     * visibility
-     * @example true
-     * @default The default visibility of the layer
-     * @description Set the visibility of the field
-     */
-    visible?: boolean;
-};
-
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
@@ -81,22 +7,42 @@ type Modification = {
 
 
 interface paths {
-  "/v1/liveness": {
-    get: {
+  "/v1/templates/createImage": {
+    /** @description Create an image from a template */
+    post: {
+      requestBody: {
+        content: {
+          "application/json": {
+            /**
+             * @default png
+             * @enum {string}
+             */
+            format?: "png" | "svg";
+            /** @description Only for debug purpose, it draws bounding box for each layer */
+            _debug?: string;
+            apiKey: string;
+            /**
+             * @description Your template id
+             * @example tpl_xxxxxxxxx
+             */
+            templateId: string;
+            /** @default [] */
+            modifications?: components["schemas"]["Modification"][];
+          };
+        };
+      };
       responses: {
-        /** @description The configured services and their status */
+        /** @description A image file */
         200: {
           content: {
-            "application/json": {
-              /** @description The status of the server */
-              status: string;
-            };
+            "image/png": string;
+            "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"];
+            "application/json": components["schemas"]["ErrBadRequest"] | components["schemas"]["ErrFetchImageError"];
           };
         };
         /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
@@ -138,16 +84,87 @@ interface paths {
       };
     };
   };
-  "/v1/templates/createImage": {
+  "/v1/templates/createPdf": {
+    post: {
+      requestBody: {
+        content: {
+          "application/json": {
+            apiKey: string;
+            /**
+             * @description Your template ID
+             * @example tpl_xxx
+             */
+            templateId: string;
+            /** @default [] */
+            modifications?: components["schemas"]["Modification"][];
+          };
+        };
+      };
+      responses: {
+        /** @description Success create pdf */
+        200: {
+          content: {
+            "application/pdf": 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"] | components["schemas"]["ErrFetchImageError"];
+          };
+        };
+        /** @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/signedurl": {
+    /** @description Generate a signed URL for a template */
     get: {
       parameters: {
         query: {
-          modifications?: string;
           format?: "png" | "svg";
           nocache?: string;
           _debug?: string;
-          apiKey: string;
           templateId: string;
+          apiKeyMd5?: string;
+          apiKeyHashed?: string;
+          sign: string;
+          modifications?: string;
         };
       };
       responses: {
@@ -155,13 +172,12 @@ interface paths {
         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"];
+            "application/json": components["schemas"]["ErrBadRequest"] | components["schemas"]["ErrFetchImageError"];
           };
         };
         /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
@@ -203,30 +219,244 @@ interface paths {
       };
     };
   };
-  "/v1/templates/imageSignedUrl": {
+  "/v1/info": {
+    /** @description Get project info */
     get: {
       parameters: {
         query: {
-          modifications?: string;
-          format?: "png" | "svg";
-          nocache?: string;
-          _debug?: string;
-          templateId: string;
-          apiKeyMd5: string;
-          sign: string;
+          apiKey: string;
         };
       };
       responses: {
-        /** @description A image file */
+        /** @description Project info */
         200: {
           content: {
-            "image/png": unknown;
+            "application/json": {
+              id: string;
+              name: string;
+              createdAt: 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"] | components["schemas"]["ErrFetchImageError"];
+          };
+        };
+        /** @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": {
+    /** @description List templates */
+    get: {
+      parameters: {
+        query: {
+          apiKey: string;
+          includeLayers?: string;
+        };
+      };
+      responses: {
+        /** @description A list of templates */
+        200: {
+          content: {
+            "application/json": 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"] | components["schemas"]["ErrFetchImageError"];
+          };
+        };
+        /** @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/:id": {
+    /** @description Template details */
+    get: {
+      parameters: {
+        query: {
+          apiKey: string;
+        };
+      };
+      responses: {
+        /** @description Template details */
+        200: {
+          content: {
+            "application/json": {
+              /** @description The name of the template */
+              name: string;
+              /** @description The id of the template */
+              id: string;
+              /** @description The layers of the template */
+              layers: ({
+                  /** @description The name of the layer */
+                  name: string;
+                  /** @description The id of the layer */
+                  id: string;
+                  /** @description The type of the layer */
+                  type: string;
+                  /** @description The suggest input of the layer */
+                  suggestInput: string | null;
+                })[];
+            };
+          };
+        };
+        /** @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"] | components["schemas"]["ErrFetchImageError"];
+          };
+        };
+        /** @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/createStoredImage": {
+    /** @description Create an image from a template */
+    post: {
+      requestBody: {
+        content: {
+          "application/json": {
+            /**
+             * @default png
+             * @enum {string}
+             */
+            format?: "png" | "svg";
+            /** @description Only for debug purpose, it draws bounding box for each layer */
+            _debug?: string;
+            apiKey: string;
+            /**
+             * @description Your template id
+             * @example tpl_xxxxxxxxx
+             */
+            templateId: string;
+            /** @default [] */
+            modifications?: components["schemas"]["Modification"][];
+          };
+        };
+      };
+      responses: {
+        /** @description Image object */
+        200: {
+          content: {
+            "application/json": {
+              url: 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"];
+            "application/json": components["schemas"]["ErrBadRequest"] | components["schemas"]["ErrFetchImageError"];
           };
         };
         /** @description Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. */
@@ -294,6 +524,28 @@ interface components {
         requestId: string;
       };
     };
+    ErrFetchImageError: {
+      error: {
+        /**
+         * @description A machine readable error code.
+         * @example FETCH_IMAGE_ERROR
+         * @enum {string}
+         */
+        code: "FETCH_IMAGE_ERROR";
+        /**
+         * @description A link to our documentation with more details about this error code
+         * @example https://bannerify.co/docs/api-reference/errors/code/FETCH_IMAGE_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;
+      };
+    };
     ErrUnauthorized: {
       error: {
         /**
@@ -426,6 +678,75 @@ interface components {
         requestId: string;
       };
     };
+    /** @description A modification (aka override) to apply to the layer in image */
+    Modification: {
+      /**
+       * @description The layer name of the modification
+       * @example Text 1
+       */
+      name: string;
+      /**
+       * @description The color for the modification
+       * @example #FF0000
+       */
+      color?: string;
+      /**
+       * @description The source image for the modification
+       * @example https://example.com/image.jpg
+       */
+      src?: string;
+      /**
+       * @description You can modify the text layer with this field
+       * @example Hello World
+       */
+      text?: string;
+      /**
+       * @description Modify the barcode layer content with this field
+       * @example 1234567890
+       */
+      barcode?: string;
+      /**
+       * @description Modify the qrcode layer content with this field
+       * @example Some text
+       */
+      qrcode?: string;
+      /** @description Update chart layer's data, follow chart.js data structure */
+      chart?: {
+        [key: string]: unknown;
+      };
+      /**
+       * @description Set the visibility of the field
+       * @example true
+       */
+      visible?: boolean;
+      /**
+       * @description Star value
+       * @example 5
+       */
+      star?: number;
+      /**
+       * @description Table width mode
+       * @example adaptive
+       * @enum {string}
+       */
+      widthMode?: "standard" | "adaptive";
+      /**
+       * @description Table height mode
+       * @example adaptive
+       * @enum {string}
+       */
+      heightMode?: "standard" | "adaptive";
+      /**
+       * @description Table theme
+       * @example NONE
+       * @enum {string}
+       */
+      theme?: "NONE" | "DEFAULT" | "BRIGHT" | "SIMPLIFY" | "ARCO";
+      /** @description Table rows */
+      rows?: unknown[];
+      /** @description Table columns */
+      columns?: string[];
+    };
   };
   responses: never;
   parameters: {
@@ -435,8 +756,89 @@ interface components {
   pathItems: never;
 }
 
+type Modification = NonNullable<paths["/v1/templates/createImage"]["post"]["requestBody"]["content"]["application/json"]["modifications"]>[0] & {
+    name: string;
+    /**
+     * color
+     * @example #FF0000
+     * @default The default color of the layer
+     * @description The color for the modification, accept any valid CSS color value, for example: #FF0000, red, rgba(0,0,0,0.5), etc. You can only modify the color of the text layer with this field.
+     */
+    color?: string;
+    /**
+     * star
+     * @example 5
+     * @default The default star of the layer
+     * @description The star for the modification, accept range 1-5, for example: 5, 4, 3, 2, 1.
+     */
+    star?: number;
+    /**
+     * background color
+     * @example #FF0000
+     * @default The default background color of the layer
+     * @description The background color for the modification, accept any valid CSS color value, for example: #FF0000, red, rgba(0,0,0,0.5), etc.
+     */
+    background?: string;
+    /**
+     * font size
+     * @example 12
+     * @default The default font size of the layer
+     * @description The font size for the modification, accept any valid CSS font size value, for example: 12, 12px;
+     */
+    size?: number;
+    /**
+     * source image
+     * @example https://example.com/image.jpg
+     * @default The default source image of the layer
+     * @description The source image for the modification, accept any valid image URL, for example: https://example.com/image.jpg
+     */
+    src?: string;
+    /**
+     * chart data
+     * @example { labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'], datasets: [{ label: 'My First Dataset', data: [65, 59, 80, 81, 56, 55, 40], fill: false, borderColor: 'rgb(75, 192, 192)', tension: 0.1 }] }
+     * @default The default chart data of the layer
+     * @description Update chart layer's data, follow chart.js data structure
+     */
+    chart?: ChartData;
+    /**
+     * text content
+     * @example Hello World
+     * @default The default text content of the layer
+     * @description You can modify the text layer with this field
+     */
+    text?: string;
+    /**
+     * barcode content
+     * @example 1234567890
+     * @default The default barcode content of the layer
+     * @description Modify the barcode layer content with this field
+     */
+    qrcode?: string;
+    /**
+     * qrcode content
+     * @example Some text
+     * @default The default qrcode content of the layer
+     * @description Modify the qrcode layer content with this field
+     */
+    barcode?: string;
+    /**
+     * icon name
+     * @example Menu
+     * @default The default icon name of the layer
+     * @description Modify the icon name with this field
+     */
+    icon?: string;
+    /**
+     * visibility
+     * @example true
+     * @default The default visibility of the layer
+     * @description Set the visibility of the field
+     */
+    visible?: boolean;
+};
+
 type codes = '400' | '401' | '403' | '404' | '500';
-type ErrorResponse = paths['/v1/liveness']['get']['responses'][codes]['content']['application/json'];
+type ErrorResponse = paths['/v1/templates/createImage']['post']['responses'][codes]['content']['application/json'];
 declare const timeoutError: {
     error: {
         code: string;
@@ -461,7 +863,7 @@ interface Options {
 type CreateOptions = {
     modifications?: Modification[];
     nocache?: boolean;
-    format?: 'svg' | 'png';
+    format?: "svg" | "png";
 };
 declare function createClient(apiKey: string, opts?: Options): Bannerify;
 declare class Bannerify {
@@ -472,8 +874,96 @@ declare class Bannerify {
     private readonly baseUrl;
     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>;
+    createPdf(templateId: string, options?: CreateOptions): Promise<{
+        error: {
+            code: "BAD_REQUEST";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "FETCH_IMAGE_ERROR";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "UNAUTHORIZED";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "FORBIDDEN";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "NOT_FOUND";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "INTERNAL_SERVER_ERROR";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        result: ArrayBuffer;
+    }>;
+    createStoredImage(templateId: string, options?: CreateOptions): Promise<{
+        error: {
+            code: "BAD_REQUEST";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "FETCH_IMAGE_ERROR";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "UNAUTHORIZED";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "FORBIDDEN";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "NOT_FOUND";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        error: {
+            code: "INTERNAL_SERVER_ERROR";
+            docs: string;
+            message: string;
+            requestId: string;
+        };
+    } | {
+        result: string;
+    }>;
     generateImageSignedUrl(templateId: string, options?: CreateOptions): Promise<string>;
 }