@shophost/client 2.0.34 → 2.0.36

package/package.json

@@ -1,18 +1,20 @@
 {
   "name": "@shophost/client",
-  "version": "2.0.34",
+  "version": "2.0.36",
   "type": "module",
-  "main": "./src/index.js",
+  "main": "./index.js",
   "types": "./src/index.d.ts",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "import": "./src/index.js"
+      "import": "./index.js"
     }
   },
   "files": [
+    "index.js",
     "src",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "keywords": [
     "client",
@@ -21,7 +23,7 @@
     "typescript"
   ],
   "author": "Abhishek Shaji (kontakt@abhishek.pl)",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/abhishek-shaji/shophost",
@@ -32,6 +34,5 @@
   },
   "devDependencies": {
     "@hey-api/client-fetch": "^0.13.0"
-  },
-  "module": "./src/index.js"
+  }
 }

package/src/index.d.ts

@@ -5,10 +5,54 @@ export type PaymentMethodDetails = import("./__generated__/sdk").GetAvailablePay
 export type CreateShippingAddressInput = import("./__generated__/sdk").CreateShippingAddressData["body"];
 export type UpdateShippingAddressInput = import("./__generated__/sdk").UpdateShippingAddressData["body"];
 export type ShippingAddress = import("./__generated__/sdk").GetShippingAddressResponses[200];
+export type Currency = import("./__generated__/sdk").OrganizationConfiguration["defaultCurrency"];
 export type PaginatedResponse<T> = {
     list: T[];
     meta: import("./__generated__/sdk").PaginationMeta;
 };
+export type AnalyticsRange = {
+    from: string;
+    to: string;
+};
+export type AnalyticsSummary = {
+    currency: Currency;
+    totalSales: number;
+    paidOrders: number;
+    averageOrderValue: number;
+    reservations: number;
+    guests: number;
+};
+export type AnalyticsSalesPoint = {
+    date: string;
+    label: string;
+    totalSales: number;
+    paidOrders: number;
+};
+export type AnalyticsReservationPoint = {
+    date: string;
+    label: string;
+    reservations: number;
+    guests: number;
+};
+export type AnalyticsPaymentMethod = "card" | "blik" | "paypal" | "bank_transfer" | "cash_on_delivery";
+export type AnalyticsPaymentMethodBreakdown = {
+    method: AnalyticsPaymentMethod;
+    count: number;
+    totalSales: number;
+};
+export type AnalyticsFulfilmentMethodBreakdown = {
+    method: "delivery" | "pickup";
+    count: number;
+    totalSales: number;
+};
+export type AnalyticsOverview = {
+    range: AnalyticsRange;
+    summary: AnalyticsSummary;
+    salesByDay: AnalyticsSalesPoint[];
+    reservationsByDay: AnalyticsReservationPoint[];
+    paymentMethods: AnalyticsPaymentMethodBreakdown[];
+    fulfilmentMethods: AnalyticsFulfilmentMethodBreakdown[];
+};
 interface RequestInput {
     body?: unknown;
     headers?: Record<string, unknown>;
@@ -29,6 +73,17 @@ export interface ClientResponse<TBody = any> {
     status: number;
 }
 export declare const initClient: ({ baseHeaders, baseUrl, credentials, fetch, throwOnUnknownStatus, }: InitClientOptions) => {
+    analytics: {
+        getOverview: (input: {
+            params: {
+                organizationId: string;
+            };
+            query: {
+                from: string;
+                to: string;
+            };
+        }) => Promise<ClientResponse<AnalyticsOverview>>;
+    };
     access: {
         acceptInvitation: (input?: RequestInput) => Promise<ClientResponse<any>>;
         createInvitation: (input?: RequestInput) => Promise<ClientResponse<any>>;