chore: add linting to prevent #19

.eslintrc.js

@@ -10,6 +10,17 @@ module.exports = {
     "prettier",
   ],
   ignorePatterns: ["**/node_modules", "**/lib", "**/package-lock.json"],
+  overrides: [
+    {
+      files: ["src/**/*.ts"],
+      rules: {
+        "no-relative-import-paths/no-relative-import-paths": [
+          "warn",
+          { prefix: "~", rootDir: "src" },
+        ],
+      },
+    },
+  ],
   parser: "@typescript-eslint/parser",
   plugins: [
     "@typescript-eslint",

package.json

@@ -19,6 +19,7 @@
     "clean": "bsm",
     "format": "bsm",
     "lint": "bsm",
+    "postinstall": "bsm",
     "prepublishOnly": "bsm build",
     "semantic-release": "semantic-release",
     "setup": "bsm build",
@@ -56,6 +57,7 @@
     "rimraf": "^5.0.5",
     "semantic-release": "^22.0.6",
     "ts-jest": "^29.1.1",
+    "ts-patch": "^3.1.2",
     "typescript": "^5.3.3",
     "typescript-transform-paths": "^3.4.6"
   },

package.scripts.js

@@ -15,6 +15,7 @@ module.exports = {
       eslint: "eslint .",
       prettier: "prettier -c .",
     },
+    postinstall: ["ts-patch install"],
     test: {
       $env: "file:.env",
       _ci: "jest --runInBand --forceExit --detectOpenHandles",

src/AxiosHttpHandler.ts

@@ -1,7 +1,7 @@
 import axios, { Axios, AxiosRequestConfig, AxiosResponse } from "axios";
 import debug from "debug";
-import { HttpHandler } from "./HttpHandler";
-import { PrintOneOptions } from "./PrintOne";
+import { HttpHandler } from "~/HttpHandler";
+import { PrintOneOptions } from "~/PrintOne";
 
 export class AxiosHTTPHandler extends HttpHandler<
   AxiosRequestConfig,

src/HttpHandler.ts

@@ -1,6 +1,6 @@
 import debug from "debug";
-import { PrintOneError } from "./errors/PrintOneError";
-import { PrintOneOptions } from "./PrintOne";
+import { PrintOneError } from "~/errors/PrintOneError";
+import { PrintOneOptions } from "~/PrintOne";
 
 export abstract class HttpHandler<RequestOptions, Response> {
   protected readonly debug: debug.Debugger;

src/PrintOne.ts

@@ -1,7 +1,7 @@
-import { Company } from "./models/Company";
+import { Company } from "~/models/Company";
 import debug from "debug";
-import { HttpHandler } from "./HttpHandler";
-import { ICompany } from "./models/_interfaces/ICompany";
+import { HttpHandler } from "~/HttpHandler";
+import { ICompany } from "~/models/_interfaces/ICompany";
 import {
   ContainsFilter,
   containsFilterToQuery,
@@ -15,23 +15,23 @@ import {
   mapInFilter,
   PaginationOptions,
   sortToQuery,
-} from "./utils";
-import { IPaginatedResponse } from "./models/_interfaces/IPaginatedResponse";
-import { ICustomFile } from "./models/_interfaces/ICustomFile";
-import { PaginatedResponse } from "./models/PaginatedResponse";
-import { CustomFile } from "./models/CustomFile";
-import { ITemplate } from "./models/_interfaces/ITemplate";
-import { CreateTemplate, Template } from "./models/Template";
-import { CreateOrder, Order } from "./models/Order";
-import { IOrder } from "./models/_interfaces/IOrder";
-import { FriendlyStatus } from "./enums/Status";
-import { Format } from "./enums/Format";
-import { AxiosHTTPHandler } from "./AxiosHttpHandler";
-import { CreateCsvOrder, CsvOrder } from "./models/CsvOrder";
-import { ICsvOrder } from "./models/_interfaces/ICsvOrder";
-import { Batch, CreateBatch } from "./models/Batch";
-import { IBatch } from "./models/_interfaces/IBatch";
-import { BatchStatus } from "./enums/BatchStatus";
+} from "~/utils";
+import { IPaginatedResponse } from "~/models/_interfaces/IPaginatedResponse";
+import { ICustomFile } from "~/models/_interfaces/ICustomFile";
+import { PaginatedResponse } from "~/models/PaginatedResponse";
+import { CustomFile } from "~/models/CustomFile";
+import { ITemplate } from "~/models/_interfaces/ITemplate";
+import { CreateTemplate, Template } from "~/models/Template";
+import { CreateOrder, Order } from "~/models/Order";
+import { IOrder } from "~/models/_interfaces/IOrder";
+import { FriendlyStatus } from "~/enums/Status";
+import { Format } from "~/enums/Format";
+import { AxiosHTTPHandler } from "~/AxiosHttpHandler";
+import { CreateCsvOrder, CsvOrder } from "~/models/CsvOrder";
+import { ICsvOrder } from "~/models/_interfaces/ICsvOrder";
+import { Batch, CreateBatch } from "~/models/Batch";
+import { IBatch } from "~/models/_interfaces/IBatch";
+import { BatchStatus } from "~/enums/BatchStatus";
 
 export type RequestHandler = new (
   token: string,

src/index.ts

@@ -1,4 +1,4 @@
-import { PrintOne } from "./PrintOne";
+import { PrintOne } from "~/PrintOne";
 
 export default PrintOne;
 

src/models/Batch.ts

@@ -1,15 +1,15 @@
-import { OrderPaginatedQuery, Protected } from "../PrintOne";
-import { IBatch } from "./_interfaces/IBatch";
-import { Finish } from "../enums/Finish";
-import { BatchStatus } from "../enums/BatchStatus";
-import { Template } from "./Template";
-import { PaginatedResponse } from "./PaginatedResponse";
-import { Order } from "./Order";
-import { Address } from "./Address";
-import { IOrder } from "./_interfaces/IOrder";
-import { Format } from "../enums/Format";
-import { CreateBatchCsvOrder, CsvOrder } from "./CsvOrder";
-import { ICsvOrder } from "./_interfaces/ICsvOrder";
+import { OrderPaginatedQuery, Protected } from "~/PrintOne";
+import { IBatch } from "~/models/_interfaces/IBatch";
+import { Finish } from "~/enums/Finish";
+import { BatchStatus } from "~/enums/BatchStatus";
+import { Template } from "~/models/Template";
+import { PaginatedResponse } from "~/models/PaginatedResponse";
+import { Order } from "~/models/Order";
+import { Address } from "~/models/Address";
+import { IOrder } from "~/models/_interfaces/IOrder";
+import { Format } from "~/enums/Format";
+import { CreateBatchCsvOrder, CsvOrder } from "~/models/CsvOrder";
+import { ICsvOrder } from "~/models/_interfaces/ICsvOrder";
 
 export type CreateBatch = {
   name: string;

src/models/Company.ts

@@ -1,5 +1,5 @@
-import { ICompany } from "./_interfaces/ICompany";
-import { Protected } from "../PrintOne";
+import { ICompany } from "~/models/_interfaces/ICompany";
+import { Protected } from "~/PrintOne";
 
 export class Company {
   constructor(

src/models/CsvOrder.ts

@@ -1,12 +1,12 @@
-import { OrderPaginatedQuery, Protected } from "../PrintOne";
-import { Finish } from "../enums/Finish";
-import { Format } from "../enums/Format";
-import { Address } from "./Address";
-import { Template } from "./Template";
-import { ICsvOrder } from "./_interfaces/ICsvOrder";
-import { CsvStatus, FriendlyCsvStatusText } from "../enums/CsvStatus";
-import { Order } from "./Order";
-import { PaginatedResponse } from "./PaginatedResponse";
+import { OrderPaginatedQuery, Protected } from "~/PrintOne";
+import { Finish } from "~/enums/Finish";
+import { Format } from "~/enums/Format";
+import { Address } from "~/models/Address";
+import { Template } from "~/models/Template";
+import { ICsvOrder } from "~/models/_interfaces/ICsvOrder";
+import { CsvStatus, FriendlyCsvStatusText } from "~/enums/CsvStatus";
+import { Order } from "~/models/Order";
+import { PaginatedResponse } from "~/models/PaginatedResponse";
 
 export type CreateCsvOrder = {
   file: ArrayBuffer;

src/models/CustomFile.ts

@@ -1,5 +1,5 @@
-import { Protected } from "../PrintOne";
-import { ICustomFile } from "./_interfaces/ICustomFile";
+import { Protected } from "~/PrintOne";
+import { ICustomFile } from "~/models/_interfaces/ICustomFile";
 
 export class CustomFile {
   constructor(

src/models/Order.ts

@@ -1,11 +1,11 @@
-import { IOrder } from "./_interfaces/IOrder";
-import { Protected } from "../PrintOne";
-import { Finish } from "../enums/Finish";
-import { Format } from "../enums/Format";
-import { Address } from "./Address";
-import { Template } from "./Template";
-import { FriendlyStatus, Status } from "../enums/Status";
-import { sleep } from "../utils";
+import { IOrder } from "~/models/_interfaces/IOrder";
+import { Protected } from "~/PrintOne";
+import { Finish } from "~/enums/Finish";
+import { Format } from "~/enums/Format";
+import { Address } from "~/models/Address";
+import { Template } from "~/models/Template";
+import { FriendlyStatus, Status } from "~/enums/Status";
+import { sleep } from "~/utils";
 
 export type CreateOrder = {
   recipient: Address;

src/models/PaginatedResponse.ts

@@ -1,5 +1,5 @@
-import { IPaginatedResponse } from "./_interfaces/IPaginatedResponse";
-import { Protected } from "../PrintOne";
+import { IPaginatedResponse } from "~/models/_interfaces/IPaginatedResponse";
+import { Protected } from "~/PrintOne";
 
 export type Meta = {
   total: number;

src/models/Preview.ts

@@ -1,10 +1,10 @@
-import { IPreview } from "./_interfaces/IPreview";
-import { Protected } from "../PrintOne";
-import { PrintOneError } from "../errors/PrintOneError";
-import { PreviewDetails } from "./PreviewDetails";
-import { IPreviewDetails } from "./_interfaces/IPreviewDetails";
-import { TimeoutError } from "../errors/TimeoutError";
-import { sleep } from "../utils";
+import { IPreview } from "~/models/_interfaces/IPreview";
+import { Protected } from "~/PrintOne";
+import { PrintOneError } from "~/errors/PrintOneError";
+import { PreviewDetails } from "~/models/PreviewDetails";
+import { IPreviewDetails } from "~/models/_interfaces/IPreviewDetails";
+import { TimeoutError } from "~/errors/TimeoutError";
+import { sleep } from "~/utils";
 
 export class Preview {
   private _data: IPreview;

src/models/PreviewDetails.ts

@@ -1,5 +1,5 @@
-import { Protected } from "../PrintOne";
-import { IPreviewDetails } from "./_interfaces/IPreviewDetails";
+import { Protected } from "~/PrintOne";
+import { IPreviewDetails } from "~/models/_interfaces/IPreviewDetails";
 
 export class PreviewDetails {
   private _data: IPreviewDetails;

src/models/Template.ts

@@ -1,8 +1,8 @@
-import { Protected } from "../PrintOne";
-import { IFullTemplate, ITemplate } from "./_interfaces/ITemplate";
-import { Format } from "../enums/Format";
-import { IPreview } from "./_interfaces/IPreview";
-import { Preview } from "./Preview";
+import { Protected } from "~/PrintOne";
+import { IFullTemplate, ITemplate } from "~/models/_interfaces/ITemplate";
+import { Format } from "~/enums/Format";
+import { IPreview } from "~/models/_interfaces/IPreview";
+import { Preview } from "~/models/Preview";
 
 export type CreateTemplate = {
   name: string;

src/models/_interfaces/ICsvOrder.ts

@@ -1,4 +1,4 @@
-import { Address } from "../../models/Address";
+import { Address } from "~/models/Address";
 
 export type ICsvOrder = {
   id: string;

src/models/_interfaces/IOrder.ts

@@ -1,4 +1,4 @@
-import { Address } from "../../models/Address";
+import { Address } from "~/models/Address";
 
 export type IOrder = {
   id: string;

tsconfig.json

@@ -22,8 +22,10 @@
       { "transform": "typescript-transform-paths" },
       { "transform": "typescript-transform-paths", "afterDeclarations": true }
     ],
-
-    "baseUrl": "./",
+    "paths": {
+      "~/*": ["*"]
+    },
+    "baseUrl": "./src",
     "outDir": "./lib"
   },