@develemit/commerce-admin 0.0.0-stage → 0.4.0

package/dist/lib/discount-form.d.ts

@@ -0,0 +1,28 @@
+import { Discount, DiscountInput, DiscountPatch, DiscountType } from '@develemit/commerce-contracts';
+import { DiscountLabels } from './discount-labels';
+export interface DiscountForm {
+    code: string;
+    type: DiscountType;
+    percentOff: string;
+    amountOff: string;
+    minSubtotal: string;
+    startsAt: string;
+    endsAt: string;
+    maxRedemptions: string;
+}
+export type DiscountFieldName = keyof DiscountForm;
+export type DiscountFieldErrors = Partial<Record<DiscountFieldName, string>>;
+export declare const emptyDiscountForm: DiscountForm;
+export declare function isoToLocalInput(iso: string | null | undefined): string;
+export declare function formFromDiscount(discount: Discount): DiscountForm;
+export declare function isDiscountUsed(discount: Discount | undefined): boolean;
+export type DiscountValidation = {
+    ok: true;
+    input: DiscountInput;
+} | {
+    ok: false;
+    errors: DiscountFieldErrors;
+};
+export declare function validateDiscountForm(form: DiscountForm, labels: DiscountLabels, currency: string, usedCount?: number): DiscountValidation;
+export declare function buildDiscountPatch(original: Discount, input: DiscountInput, locked: boolean): DiscountPatch;
+export declare function mapDiscountIssues(issues: unknown[], message: string): DiscountFieldErrors;

package/dist/lib/discount-labels.d.ts

@@ -0,0 +1,56 @@
+export type DiscountTab = 'active' | 'scheduled' | 'expired' | 'inactive';
+export interface DiscountLabels {
+    title: string;
+    newDiscount: string;
+    searchLabel: string;
+    searchPlaceholder: string;
+    tabs: Record<DiscountTab, string>;
+    empty: Record<DiscountTab, string>;
+    noMatches: string;
+    loadMore: string;
+    columns: {
+        code: string;
+        value: string;
+        status: string;
+        usage: string;
+    };
+    usage: string;
+    usageUnlimited: string;
+    createTitle: string;
+    editTitle: string;
+    saved: string;
+    fields: {
+        code: string;
+        type: string;
+        percentOff: string;
+        amountOff: string;
+        minSubtotal: string;
+        startsAt: string;
+        endsAt: string;
+        maxRedemptions: string;
+    };
+    types: {
+        percent: string;
+        fixed: string;
+    };
+    optionalHelp: string;
+    lockedHelp: string;
+    deactivate: string;
+    deactivateTitle: string;
+    deactivateBody: string;
+    reactivate: string;
+    validation: {
+        code: string;
+        percentOff: string;
+        amountOff: string;
+        minSubtotal: string;
+        maxRedemptions: string;
+        maxRedemptionsBelowUsage: string;
+        endsBeforeStart: string;
+        date: string;
+        codeTaken: string;
+        invalid: string;
+    };
+    orderRow: string;
+}
+export declare const defaultDiscountLabels: DiscountLabels;

package/dist/lib/discount-status.d.ts

@@ -0,0 +1,5 @@
+import { Discount, DiscountStatus } from '@develemit/commerce-contracts';
+type StatusFields = Pick<Discount, 'active' | 'startsAt' | 'endsAt'>;
+export declare function displayDiscountStatus(discount: StatusFields, now?: Date): DiscountStatus;
+export declare function fillTemplate(template: string, values: Record<string, string | number>): string;
+export {};

package/dist/lib/image-labels.d.ts

@@ -0,0 +1,27 @@
+export interface ImageLabels {
+    title: string;
+    empty: string;
+    add: string;
+    takePhoto: string;
+    dropHint: string;
+    altLabel: string;
+    altHelp: string;
+    altWarning: string;
+    cover: string;
+    photoName: string;
+    editAlt: string;
+    saveAlt: string;
+    cancelAlt: string;
+    moveEarlier: string;
+    moveLater: string;
+    remove: string;
+    removeTitle: string;
+    removeBody: string;
+    uploading: string;
+    working: string;
+    tooLarge: string;
+    wrongType: string;
+    reorderFailed: string;
+    dismiss: string;
+}
+export declare const defaultImageLabels: ImageLabels;

package/dist/lib/image-rules.d.ts

@@ -0,0 +1,4 @@
+import { ImageLabels } from './image-labels';
+export declare const MAX_IMAGE_BYTES: number;
+export declare function fill(template: string, values: Record<string, string>): string;
+export declare function imageFileProblem(file: File, labels: ImageLabels): string | null;

package/dist/lib/merge-labels.d.ts

@@ -0,0 +1,19 @@
+import { AdminLabels } from './admin-labels';
+import { OrderLabels } from './order-labels';
+import { ShippingLabels } from './shipping-labels';
+import { DiscountLabels } from './discount-labels';
+import { ProductLabels } from './product-labels';
+type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? Partial<T[K]> : T[K];
+};
+export type AdminLabelOverrides = Partial<Omit<AdminLabels, 'nav' | 'statuses' | 'errors' | 'products' | 'orders' | 'shipping' | 'discounts'> & {
+    nav: Partial<AdminLabels['nav']>;
+    statuses: Partial<AdminLabels['statuses']>;
+    errors: Partial<AdminLabels['errors']>;
+    products: DeepPartial<ProductLabels>;
+    orders: DeepPartial<OrderLabels>;
+    shipping: Partial<ShippingLabels>;
+    discounts: DeepPartial<DiscountLabels>;
+}>;
+export declare function mergeAdminLabels(labels: AdminLabelOverrides | undefined): AdminLabels;
+export {};

package/dist/lib/money-input.d.ts

@@ -0,0 +1,2 @@
+export declare function parseMoneyInput(raw: string): number | null;
+export declare function formatMoneyInput(cents: number): string;

package/dist/lib/order-action-labels.d.ts

@@ -0,0 +1,28 @@
+export interface OrderActionLabels {
+    ship: string;
+    reship: string;
+    shipHeading: string;
+    carrier: string;
+    trackingNumber: string;
+    trackingUrl: string;
+    trackingUrlInvalid: string;
+    shipped: string;
+    refund: string;
+    refundTitle: string;
+    refundAmount: string;
+    refundAmountInvalid: string;
+    refundReason: string;
+    refundSubmit: string;
+    refundRetry: string;
+    restock: string;
+    restockWarning: string;
+    refundPending: string;
+    refundUnknown: string;
+    refundGateway: string;
+    refundDone: string;
+    resolve: string;
+    resolveHelp: string;
+    resolved: string;
+    restockThenResolve: string;
+}
+export declare const defaultOrderActionLabels: OrderActionLabels;

package/dist/lib/order-labels.d.ts

@@ -0,0 +1,66 @@
+import { OrderActionLabels } from './order-action-labels';
+export type OrderTab = 'paid' | 'shipped' | 'needs_attention' | 'pending_refund' | 'all';
+export interface OrderLabels {
+    title: string;
+    searchLabel: string;
+    searchPlaceholder: string;
+    tabs: Record<OrderTab, string>;
+    empty: Record<OrderTab, string>;
+    noMatches: string;
+    loadMore: string;
+    columns: {
+        order: string;
+        status: string;
+        email: string;
+        items: string;
+        total: string;
+        date: string;
+    };
+    noEmail: string;
+    detailTitle: string;
+    back: string;
+    placed: string;
+    buyer: string;
+    itemsHeading: string;
+    itemColumns: {
+        name: string;
+        price: string;
+        quantity: string;
+        line: string;
+    };
+    subtotal: string;
+    shipping: string;
+    total: string;
+    shippingAddress: string;
+    noAddress: string;
+    fulfillment: string;
+    notShipped: string;
+    shippedOn: string;
+    carrier: string;
+    tracking: string;
+    trackShipment: string;
+    refunds: string;
+    noRefunds: string;
+    refundColumns: {
+        amount: string;
+        reason: string;
+        source: string;
+        status: string;
+        restocked: string;
+        date: string;
+    };
+    refundSources: {
+        admin: string;
+        gateway: string;
+    };
+    refundStatuses: {
+        pending: string;
+        succeeded: string;
+    };
+    yes: string;
+    no: string;
+    refunded: string;
+    remaining: string;
+    actions: OrderActionLabels;
+}
+export declare const defaultOrderLabels: OrderLabels;

package/dist/lib/product-filter.d.ts

@@ -0,0 +1,6 @@
+import { AdminProduct, ProductStatus } from '@develemit/commerce-contracts';
+import { ProductFilter } from './product-labels';
+export declare function isSold(product: AdminProduct): boolean;
+export declare function displayStatus(product: AdminProduct): string;
+export declare function serverStatus(filter: ProductFilter): ProductStatus | undefined;
+export declare function serverStock(filter: ProductFilter): 'in' | 'sold' | undefined;

package/dist/lib/product-form.d.ts

@@ -0,0 +1,29 @@
+import { AdminProduct, AdminProductInput, AdminProductPatch, ProductStatus } from '@develemit/commerce-contracts';
+import { ProductLabels } from './product-labels';
+export declare const FIELD_ORDER: readonly ["name", "category", "description", "materials", "dimensions", "price", "quantity", "status", "featured"];
+export type FieldName = (typeof FIELD_ORDER)[number];
+export type FieldErrors = Partial<Record<FieldName, string>>;
+export interface ProductForm {
+    name: string;
+    category: string;
+    description: string;
+    materials: string;
+    dimensions: string;
+    price: string;
+    quantity: string;
+    status: ProductStatus;
+    featured: boolean;
+}
+export declare const emptyForm: ProductForm;
+export declare function formFromProduct(product: AdminProduct): ProductForm;
+export declare function mapServerIssues(issues: unknown[]): FieldErrors;
+export declare function firstInvalidField(errors: FieldErrors): FieldName | undefined;
+export type ValidationResult = {
+    ok: true;
+    input: AdminProductInput;
+} | {
+    ok: false;
+    errors: FieldErrors;
+};
+export declare function validateForm(form: ProductForm, labels: ProductLabels, currency?: string): ValidationResult;
+export declare function buildPatch(original: AdminProduct, input: AdminProductInput): AdminProductPatch;

package/dist/lib/product-labels.d.ts

@@ -0,0 +1,52 @@
+import { ImageLabels } from './image-labels';
+export type ProductFilter = 'all' | 'live' | 'sold' | 'draft' | 'archived';
+export interface ProductLabels {
+    title: string;
+    newProduct: string;
+    searchLabel: string;
+    searchPlaceholder: string;
+    filters: Record<ProductFilter, string>;
+    empty: Record<ProductFilter, string>;
+    noMatches: string;
+    loadMore: string;
+    columns: {
+        image: string;
+        name: string;
+        price: string;
+        status: string;
+        quantity: string;
+        actions: string;
+    };
+    noImage: string;
+    viewInShop: string;
+    markSold: string;
+    archive: string;
+    markSoldTitle: string;
+    markSoldBody: string;
+    archiveTitle: string;
+    archiveBody: string;
+    updated: string;
+    createTitle: string;
+    editTitle: string;
+    saved: string;
+    fields: {
+        name: string;
+        category: string;
+        description: string;
+        materials: string;
+        dimensions: string;
+        price: string;
+        quantity: string;
+        status: string;
+        featured: string;
+    };
+    images: ImageLabels;
+    statusHelp: string;
+    priceHelp: string;
+    validation: {
+        required: string;
+        price: string;
+        quantity: string;
+    };
+}
+export declare const defaultProductLabels: ProductLabels;

package/dist/lib/provider.d.ts

@@ -0,0 +1,45 @@
+import { AdminClient } from '../client';
+import { ReactNode } from 'react';
+import { AdminLabels } from './admin-labels';
+import { AdminLabelOverrides } from './merge-labels';
+export type { AdminErrorKey, AdminLabels } from './admin-labels';
+export interface LinkProps {
+    href: string;
+    children: ReactNode;
+    className?: string;
+}
+export interface AdminImageProps {
+    src: string;
+    alt: string;
+    sizes?: string;
+    className?: string;
+    priority?: boolean;
+}
+export interface AdminConfig {
+    renderLink: (props: LinkProps) => ReactNode;
+    renderImage: (props: AdminImageProps) => ReactNode;
+    locale: string;
+    currency: string;
+    hrefs: {
+        products: string;
+        product: (id: string) => string;
+        newProduct: string;
+        orders: string;
+        order: (id: string) => string;
+        shippingRates: string;
+        discounts: string;
+        discount: (id: string) => string;
+        newDiscount: string;
+        storefrontProduct?: (slug: string) => string;
+    };
+    client: AdminClient | null;
+    labels: AdminLabels;
+}
+export interface AdminProviderProps extends Partial<Omit<AdminConfig, 'hrefs' | 'labels'>> {
+    hrefs?: Partial<AdminConfig['hrefs']>;
+    labels?: AdminLabelOverrides;
+    children: ReactNode;
+}
+export declare function AdminProvider({ children, hrefs, labels, ...overrides }: AdminProviderProps): import('react').JSX.Element;
+export declare function useAdmin(): AdminConfig;
+export declare function useAdminClient(): AdminClient;

package/dist/lib/refund-rules.d.ts

@@ -0,0 +1,7 @@
+import { AdminOrderDetail } from '@develemit/commerce-contracts';
+export declare function pendingRefundCents(order: AdminOrderDetail): number;
+export declare function remainingRefundCents(order: AdminOrderDetail): number;
+export declare function hasPendingRefund(order: AdminOrderDetail): boolean;
+export declare function canRestock(order: AdminOrderDetail, amountCents: number | null): boolean;
+export declare function canShip(order: AdminOrderDetail): boolean;
+export declare function canRefund(order: AdminOrderDetail): boolean;

package/dist/lib/shipping-labels.d.ts

@@ -0,0 +1,33 @@
+export interface ShippingLabels {
+    title: string;
+    loading: string;
+    empty: string;
+    add: string;
+    save: string;
+    saved: string;
+    label: string;
+    amount: string;
+    currency: string;
+    mixedCurrency: string;
+    minDays: string;
+    maxDays: string;
+    active: string;
+    rowName: string;
+    moveEarlier: string;
+    moveLater: string;
+    remove: string;
+    removeTitle: string;
+    removeBody: string;
+    newRateLabel: string;
+    removalWarning: string;
+    unsaved: string;
+    noActive: string;
+    labelRequired: string;
+    labelDuplicate: string;
+    amountInvalid: string;
+    currencyInvalid: string;
+    daysInvalid: string;
+    daysOrder: string;
+    rowInvalid: string;
+}
+export declare const defaultShippingLabels: ShippingLabels;

package/dist/lib/shipping-rates.d.ts

@@ -0,0 +1,31 @@
+import { ShippingRate, ShippingRateInput } from '@develemit/commerce-contracts';
+import { ShippingLabels } from './shipping-labels';
+export interface RateDraft {
+    key: string;
+    label: string;
+    amount: string;
+    currency: string;
+    minDays: string;
+    maxDays: string;
+    active: boolean;
+}
+export interface RateErrors {
+    label?: string;
+    amount?: string;
+    minDays?: string;
+    maxDays?: string;
+    currency?: string;
+    row?: string;
+}
+export interface DraftCheck {
+    rates: ShippingRateInput[];
+    rowErrors: Record<string, RateErrors>;
+    noActive: boolean;
+    valid: boolean;
+}
+export declare const newKey: () => string;
+export declare function toDrafts(rates: ShippingRate[]): RateDraft[];
+export declare function blankDraft(currency: string, label: string): RateDraft;
+export declare const snapshot: (drafts: RateDraft[]) => string;
+export declare function checkDrafts(drafts: RateDraft[], copy: ShippingLabels): DraftCheck;
+export declare function serverRowErrors(issues: unknown[], drafts: RateDraft[], copy: ShippingLabels): Record<string, RateErrors>;

package/dist/lib/use-admin-mutation.d.ts

@@ -0,0 +1,7 @@
+export interface AdminMutation<A extends unknown[], R> {
+    run: (...args: A) => Promise<R | undefined>;
+    pending: boolean;
+    error: unknown;
+    reset: () => void;
+}
+export declare function useAdminMutation<A extends unknown[], R>(fn: (...args: A) => Promise<R>): AdminMutation<A, R>;

package/dist/lib/use-admin-query.d.ts

@@ -0,0 +1,7 @@
+export interface AdminQuery<T> {
+    data: T | undefined;
+    error: unknown;
+    loading: boolean;
+    reload: () => void;
+}
+export declare function useAdminQuery<T>(key: readonly unknown[], fn: (signal: AbortSignal) => Promise<T>): AdminQuery<T>;

package/dist/lib/use-debounced.d.ts

@@ -0,0 +1 @@
+export declare function useDebounced<T>(value: T, delayMs: number): T;

package/dist/lib/use-discount-pages.d.ts

@@ -0,0 +1,26 @@
+import { AdminDiscountQuery } from '../client/admin-client';
+export declare function useDiscountPages(query: Omit<AdminDiscountQuery, 'cursor'>): {
+    items: {
+        redeemedCount: number;
+        reservedCount: number;
+        createdAt: string;
+        active: boolean;
+        type: "percent" | "fixed";
+        id: string;
+        code: string;
+        minSubtotalCents?: number | null | undefined;
+        startsAt?: string | null | undefined;
+        endsAt?: string | null | undefined;
+        maxRedemptions?: number | null | undefined;
+        percentOff?: number | null | undefined;
+        amountOffCents?: number | null | undefined;
+        currency?: string | null | undefined;
+    }[];
+    loaded: boolean;
+    loading: boolean;
+    error: unknown;
+    hasMore: boolean;
+    loadingMore: boolean;
+    reload: () => void;
+    loadMore: () => void;
+};

package/dist/lib/use-image-upload.d.ts

@@ -0,0 +1,18 @@
+import { AdminProduct } from '@develemit/commerce-contracts';
+export interface UploadEntry {
+    id: number;
+    name: string;
+    status: 'queued' | 'uploading' | 'error';
+    reason?: string;
+    error?: unknown;
+}
+interface Options {
+    productId: string;
+    onUploaded: (product: AdminProduct) => void;
+}
+export declare function useImageUpload({ productId, onUploaded }: Options): {
+    entries: UploadEntry[];
+    upload: (files: File[], alt: string) => void;
+    dismiss: (id: number) => void;
+};
+export {};

package/dist/lib/use-order-pages.d.ts

@@ -0,0 +1,17 @@
+import { AdminOrderQuery } from '../client/admin-client';
+export declare function useOrderPages(query: Omit<AdminOrderQuery, 'cursor'>): {
+    items: {
+        id: string;
+        status: "pending" | "paid" | "shipped" | "cancelled" | "expired" | "needs_attention" | "refunded";
+        email: string | null;
+        totalCents: number;
+        currency: string;
+        itemCount: number;
+        createdAt: string;
+    }[];
+    loading: boolean;
+    error: unknown;
+    hasMore: boolean;
+    loadingMore: boolean;
+    loadMore: () => void;
+};

package/dist/lib/use-product-pages.d.ts

@@ -0,0 +1,30 @@
+import { AdminProductQuery } from '../client/admin-client';
+export declare function useProductPages(query: Omit<AdminProductQuery, 'cursor'>): {
+    items: {
+        id: string;
+        slug: string;
+        name: string;
+        description: string;
+        materials: string | null;
+        dimensions: string | null;
+        priceCents: number;
+        currency: string;
+        category: string;
+        quantity: number;
+        status: "draft" | "active" | "archived";
+        featured: boolean;
+        images: {
+            id: string;
+            url: string;
+            alt: string;
+            position: number;
+        }[];
+    }[];
+    loaded: boolean;
+    loading: boolean;
+    error: unknown;
+    hasMore: boolean;
+    loadingMore: boolean;
+    reload: () => void;
+    loadMore: () => void;
+};