bananas-commerce-admin 0.1.0

package/dist/types/containers/Content.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare const Content: React.FC<React.PropsWithChildren<{}>>;
+export default Content;

package/dist/types/containers/ErrorScreen.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PageLoadFailedError } from "./PageLoader";
+interface ErrorScreenInnerProps {
+    error: PageLoadFailedError;
+}
+declare const ErrorScreen: React.FC<ErrorScreenInnerProps>;
+export default ErrorScreen;

package/dist/types/containers/LoadingScreen.d.ts

@@ -0,0 +1,50 @@
+import React from "react";
+import { Theme } from "@mui/material/styles";
+import { LogoType } from "../types";
+declare const styles: (theme: Theme) => {
+    readonly root: {
+        readonly position: "relative";
+        readonly top: 0;
+        readonly left: 0;
+        readonly width: "100%";
+        readonly height: "100%";
+        readonly display: "flex";
+        readonly flexDirection: "column";
+        readonly alignItems: "center";
+        readonly justifyContent: "center";
+    };
+    readonly backdrop: {
+        readonly position: "absolute";
+        readonly zIndex: 2000;
+        readonly backgroundColor: string;
+    };
+    readonly backdropPrimary: {
+        readonly backgroundColor: string;
+    };
+    readonly backdropSecondary: {
+        readonly backgroundColor: string;
+    };
+    readonly backdropPaper: {
+        readonly backgroundColor: string;
+    };
+    readonly spinner: {
+        readonly color: string;
+    };
+    readonly spinnerContrast: {
+        readonly color: string;
+    };
+    readonly logo: {
+        readonly position: "absolute";
+        readonly margin: 0;
+        readonly marginTop: string;
+    };
+};
+interface LoadingScreenProps {
+    loading?: boolean;
+    logo?: LogoType;
+    backdrop?: boolean;
+    color?: string;
+    classes?: ReturnType<typeof styles>;
+}
+declare const LoadingScreen: React.FC<LoadingScreenProps>;
+export default LoadingScreen;

package/dist/types/containers/PageErrorBoundary.d.ts

@@ -0,0 +1,16 @@
+import React from "react";
+export interface PageErrorBoundaryProps<T = Error> {
+    errorPage: React.ComponentType<{
+        error: T;
+    }>;
+    children: React.ReactNode;
+}
+export default class PageErrorBoundary<T = Error> extends React.Component<PageErrorBoundaryProps<T>> {
+    state: {
+        error: T | null;
+    };
+    errorPage: PageErrorBoundaryProps<T>["errorPage"];
+    constructor(props: PageErrorBoundaryProps<T>);
+    componentDidCatch(error: Error): void;
+    render(): React.ReactNode;
+}

package/dist/types/containers/PageLoader.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { RouteInfo } from "../contexts/RouterContext";
+import { PageComponent } from "../types";
+export declare class PageLoadFailedError extends Error {
+    readonly response: Response;
+    constructor(response: Response, message?: string);
+}
+export interface PageLoaderProps {
+    route: RouteInfo;
+    page: PageComponent | Promise<PageComponent>;
+}
+declare const PageLoader: React.FC<PageLoaderProps>;
+export default PageLoader;

package/dist/types/contexts/ApiContext.d.ts

@@ -0,0 +1,12 @@
+import * as React from "react";
+import { ApiClient } from "../api";
+export interface ApiContextProviderProps {
+    api: ApiClient | string | URL | {
+        schema: string | URL;
+        server?: string | URL;
+    };
+}
+declare const ApiContext: React.Context<ApiClient>;
+export declare const useApi: () => ApiClient;
+export declare const ApiContextProvider: React.FC<React.PropsWithChildren<ApiContextProviderProps>>;
+export default ApiContext;

package/dist/types/contexts/I18nContext.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+export declare function interpolateString(string: string, params: Record<string, string> | string[]): string;
+interface I18nContext {
+    i18n: any;
+    t: (key: string, params?: Record<string, string> | string[]) => string;
+}
+declare const I18nContext: React.Context<I18nContext>;
+export declare const useI18n: () => I18nContext;
+export declare const I18nContextProvider: React.FC<React.PropsWithChildren<{}>>;
+export default I18nContext;

package/dist/types/contexts/RouterContext.d.ts

@@ -0,0 +1,24 @@
+import * as React from "react";
+export interface RouteInfo {
+    id: string;
+    app: string;
+    view: string;
+    action: string;
+    title: string;
+    navigation: boolean;
+    path: string;
+    page: string;
+}
+interface RouterContext {
+    routes: RouteInfo[];
+    getRoute(reverse: string): RouteInfo | undefined;
+    navigate(route: number | string | RouteInfo, options?: {
+        params?: Record<string, string | number | boolean>;
+        query?: URLSearchParams;
+        replace?: boolean;
+    }): void;
+}
+declare const RouterContext: React.Context<RouterContext>;
+export declare const useRouter: () => RouterContext;
+export declare const RouterContextProvider: React.FC<React.PropsWithChildren<{}>>;
+export default RouterContext;

package/dist/types/contexts/UserContext.d.ts

@@ -0,0 +1,20 @@
+import * as React from "react";
+interface User {
+    id: string;
+    email: string;
+    is_superuser: boolean;
+    groups: string[];
+    full_name: string;
+    username: string;
+    permissions: string[];
+}
+interface UserContext {
+    user: User | null;
+    login: (username: string, password: string) => Promise<User | null>;
+    logout: () => Promise<void>;
+    changePassword: (oldPassword: string, newPassword1: string, newPassword2: string) => Promise<void>;
+}
+declare const UserContext: React.Context<UserContext>;
+export declare const useUser: () => UserContext;
+export declare const UserContextProvider: React.FC<React.PropsWithChildren<{}>>;
+export default UserContext;

package/dist/types/extensions/bananas/components/PasswordChangeForm.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare const PasswordChangeForm: React.FC;
+export default PasswordChangeForm;

package/dist/types/extensions/bananas/index.d.ts

@@ -0,0 +1,2 @@
+import { RouterExtension } from "../../router/Router";
+export declare const bananasRouterExtension: RouterExtension;

package/dist/types/extensions/bananas/pages/me/list.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+interface MePageProps {
+    editable?: boolean;
+}
+declare const MePage: React.FC<MePageProps>;
+export default MePage;

package/dist/types/extensions/pos/components/PurchaseRow.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { Purchase } from "../types/purchase";
+interface PurchaseRowProps {
+    purchase: Purchase;
+}
+export declare const PurchaseRow: React.FC<PurchaseRowProps>;
+export {};

package/dist/types/extensions/pos/components/ReceiptCard.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { Receipt } from "../types/receipt";
+interface ReceiptCardProps {
+    receipt: Receipt;
+}
+export declare const ReceiptCard: React.FC<ReceiptCardProps>;
+export {};

package/dist/types/extensions/pos/components/ReceiptLine.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { ReceiptLine as ReceiptLineType } from "../types/receipt";
+interface ReceiptLineProps {
+    line: ReceiptLineType;
+}
+export declare const ReceiptLine: React.FC<ReceiptLineProps>;
+export {};

package/dist/types/extensions/pos/index.d.ts

@@ -0,0 +1,2 @@
+import { RouterExtension } from "../../router/Router";
+export declare const posRouterExtension: RouterExtension;

package/dist/types/extensions/pos/pages/purchase/detail.d.ts

@@ -0,0 +1,7 @@
+import React from "react";
+import { PurchaseDetail } from "../../types/purchase";
+interface PurchaseDetailPageProps {
+    data: PurchaseDetail;
+}
+declare const PurchaseDetailPage: React.FC<PurchaseDetailPageProps>;
+export default PurchaseDetailPage;

package/dist/types/extensions/pos/pages/purchase/list.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { Purchase } from "../../types/purchase";
+interface PurchaseListPageProps {
+    data: {
+        results: Purchase[];
+    };
+}
+declare const PurchaseListPage: React.FC<PurchaseListPageProps>;
+export default PurchaseListPage;

package/dist/types/extensions/pos/types/purchase.d.ts

@@ -0,0 +1,18 @@
+import { Receipt } from "./receipt";
+export interface Purchase {
+    number: string;
+    checkout_session?: string;
+    main_payment_identifier?: string;
+    date_initiated: string;
+    date_confirmed: string;
+    currency?: string;
+    site_code: string;
+    locale: string;
+    country_code: string;
+    email: string;
+    phone?: string;
+}
+export interface PurchaseDetail {
+    purchase: Purchase;
+    receipts: Receipt[];
+}

package/dist/types/extensions/pos/types/receipt.d.ts

@@ -0,0 +1,34 @@
+export interface Receipt {
+    number: string;
+    total_amount: string;
+    total_discount_amount: string;
+    total_tax_amount: string;
+    date_settled?: string;
+    /**
+     * |   | Intention    |
+     * | - | ------------ |
+     * | 1 | payment      |
+     * | 2 | cancellation |
+     * | 3 | refund       |
+     */
+    intention: 1 | 2 | 3;
+    lines: ReceiptLine[];
+}
+export interface ReceiptLine {
+    reference: string;
+    title: string;
+    line_number: number;
+    item_type: string;
+    quantity: number;
+    unit_price: string;
+    total_amount: string;
+    total_discount_amount: string;
+    discounts: ReceiptLineDiscount[];
+    tax_rate: string;
+    tax_code: string;
+    total_tax_amount: string;
+}
+export interface ReceiptLineDiscount {
+    title: string;
+    amount: string;
+}

package/dist/types/forms/LoginForm.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+declare const LoginForm: React.FC;
+export default LoginForm;

package/dist/types/hooks/useAsyncError.d.ts

@@ -0,0 +1 @@
+export default function useAsyncError(): (e: any) => void;

package/dist/types/hooks/useLocalStorage.d.ts

@@ -0,0 +1,2 @@
+import React from "react";
+export default function useLocalStorage<T>(key: string, defaultValue: T): readonly [T, React.Dispatch<React.SetStateAction<T>>];

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export { default as ProgressBar } from "./components/ProgressBar";
+export { default as Content } from "./containers/Content";
+export { default as Logo } from "./components/Logo";
+export { default as Link } from "./components/Link";
+export * from "./contexts/ApiContext";
+export * from "./contexts/I18nContext";
+export * from "./contexts/RouterContext";
+export * from "./contexts/UserContext";
+export * from "./containers/LoadingScreen";
+export { default as Admin } from "./Admin";
+export { default as App } from "./App";
+export * from "./api";
+export * from "./extensions/bananas";
+export * from "./extensions/pos";

package/dist/types/pages/DashboardPage.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+interface DashboardPageProps {
+}
+declare const DashboardPage: React.FC<DashboardPageProps>;
+export default DashboardPage;

package/dist/types/pages/LoginPage.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { LogoType } from "../types";
+interface LoginPageProps {
+    title?: string;
+    logo?: LogoType;
+    form?: React.ElementType;
+}
+declare const LoginPage: React.FC<LoginPageProps>;
+export default LoginPage;

package/dist/types/router/Router.d.ts

@@ -0,0 +1,13 @@
+import React from "react";
+import { RouteInfo } from "../contexts/RouterContext";
+import { PageComponent } from "../types";
+export interface RouterExtension {
+    app: string;
+    pages: (route: RouteInfo) => PageComponent | Promise<PageComponent>;
+}
+export interface RouterProps {
+    dashboard?: React.ComponentType;
+    extensions?: RouterExtension[];
+    pages: (route: RouteInfo) => PageComponent | Promise<PageComponent>;
+}
+export declare const Router: React.FC<RouterProps>;

package/dist/types/router/routes.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Parses an `operationId` returning app, view and action
+ *
+ * ## Examples
+ *
+ * `bananas.me:list` -> `{ app: "bananas", view: "me", action: "list" }`
+ *
+ * `bananas.login:create` -> `{ app: "bananas", view: "login", action: "create" }`
+ *
+ * `bananas.i18n:list` -> `{ app: "bananas", view: "i18n", action: "list" }`
+ */
+export declare function parseOperationId(operationId: string): {
+    app: string;
+    view: string;
+    action: string;
+} | undefined;
+export declare function isNavigation(tags: string[]): boolean;
+export declare function getPath(endpoint: string, method: string, action: string | undefined): string;
+export declare function getPage(path: string, action: string | undefined): string;
+export declare function getTitle(view: string, summary?: string): string;

package/dist/types/types/index.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+declare module "swagger-client";
+export declare type LogoType = boolean | string | React.ElementType;
+export declare type PageComponent<T = any> = React.ComponentType<{
+    data: T;
+}>;

package/dist/types/util/get_cookie.d.ts

@@ -0,0 +1 @@
+export declare function getCookie(name: string): string | undefined;

package/dist/types/util/index.d.ts

@@ -0,0 +1,8 @@
+export declare function ensureTrailingSlash(path: string): string;
+export declare function ensureLeadingHash(hash: string): string;
+export declare function absolutePath(path: string, basename?: string): string;
+export declare function nthIndexOf(str: string, pattern: string, n: number, start?: number): number;
+/**
+ * Like Python’s `.capitalize()`.
+ */
+export declare function capitalize(string: string): string;

package/dist/types/util/select_styles.d.ts

@@ -0,0 +1,3 @@
+import { SxProps, Theme } from "@mui/material";
+export declare function selectStyles<T extends Theme = Theme>(...sxs: (SxProps<Theme> | (boolean | SxProps<Theme>)[] | undefined)[]): SxProps<T>;
+export declare const ss: typeof selectStyles;

package/example/Dockerfile

@@ -0,0 +1,27 @@
+FROM node:16 as build
+
+# Set working directory
+WORKDIR /usr/src/app
+
+# Install dependencies, do this first to enable caching and re-running only
+# when dependencies change!
+COPY package*.json .
+RUN npm ci
+
+# Copy the source
+COPY . .
+
+# Pre-build bananas-commerce-admin
+WORKDIR /usr/src/app/node_modules/bananas-commerce-admin
+RUN npm run build
+
+# Return back to the correct working directory
+WORKDIR /usr/src/app
+
+# Build the app source
+RUN npm run build
+
+FROM lipanski/docker-static-website:2.1.0
+
+# Copy the built app from the build step
+COPY --from=build /usr/src/app/dist /home/static

package/example/docker-compose.yml

@@ -0,0 +1,7 @@
+version: "3.9"
+
+services:
+  app:
+    build: .
+    ports:
+      - "3000:3000"

package/example/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="initial-scale=1, width=device-width" />
+    <meta name="theme-color" content="#000000" />
+    <title>Bananas Commerce Admin</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+  </body>
+</html>

package/example/index.tsx

@@ -0,0 +1,21 @@
+import React from "react";
+import ReactDOM from "react-dom";
+import * as Bananas from "bananas-commerce-admin";
+
+ReactDOM.render(
+  <React.StrictMode>
+    <Bananas.App
+      api={{
+        schema: "http://localhost:8123/_/admin/api/v1/openapi.json",
+        server: "http://localhost:8123/_/admin/api/v1/",
+      }}
+      nav={{}}
+      extensions={[Bananas.bananasRouterExtension, Bananas.posRouterExtension]}
+      pages={async (route) => {
+        console.log(route);
+        return (await import(`./pages/${route.page}`)).default;
+      }}
+    />
+  </React.StrictMode>,
+  document.getElementById("root") as HTMLElement,
+);