Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

5.0 KB
Raw Blame
import { adminClient, runtimeListParams, setApiClient } from '@spree/dashboard-core'

/**
 * Registers the Admin API client as this panel's client.
 *
 * `@spree/dashboard-core` is shared with the seller panel, which talks to a
 * different API with different credentials, so the framework holds no client
 * of its own — each host installs one. Side-effect import, run before any
 * provider mounts.
 */
setApiClient({
  auth: adminClient.auth,
  setToken: (token: string) => adminClient.setToken(token),
  onUnauthorized: (handler) => adminClient.onUnauthorized(handler),
  clearTenant: () => adminClient.setStore(''),
  fetchPermissions: async () => {
    const response = await adminClient.me.get()

    return { rules: response.permissions, keys: response.permission_keys ?? [] }
  },
  // The account menu's language switcher writes through this, so the one
  // shared component does not have to know which API it is talking to.
  updateAccount: (params) => adminClient.me.update(params),
  listCountries: () => adminClient.countries.list({ expand: ['states'] }),
  uploadFile: (file, options) => adminClient.files.upload(file, options),
  // Backs the shared CSV import wizard, which both panels render. The
  // operator imports every registered dataset; a seller's client narrows
  // `types` to their own.
  imports: {
    list: (params) => adminClient.imports.list(runtimeListParams(params)),
    get: (id) => adminClient.imports.get(id),
    create: (params) => adminClient.imports.create(params),
    completeMapping: (id, params) => adminClient.imports.completeMapping(id, params),
    retryFailedRows: (id) => adminClient.imports.retryFailedRows(id),
    delete: (id) => adminClient.imports.delete(id),
    rows: {
      list: (importId, params) =>
        adminClient.imports.rows.list(importId, runtimeListParams(params)),
    },
    types: ['products', 'customers', 'product_translations'],
    templateUrl: (type) => `/api/v3/admin/imports/template?type=${encodeURIComponent(type)}`,
    exampleUrl: (type) => `/api/v3/admin/imports/example?type=${encodeURIComponent(type)}`,
    downloadUrl: (id) => `/api/v3/admin/imports/${id}/download`,
  },
  // Backs the shared stock-locations page, which both panels render.
  stockLocations: {
    list: (params) => adminClient.stockLocations.list(runtimeListParams(params)),
    get: (id) => adminClient.stockLocations.get(id),
    create: (params) => adminClient.stockLocations.create(params),
    update: (id, params) => adminClient.stockLocations.update(id, params),
    delete: (id) => adminClient.stockLocations.delete(id),
  },
  // Reference data for the shared product form.
  optionTypes: {
    list: (params) =>
      adminClient.optionTypes.list(runtimeListParams({ ...params, expand: ['option_values'] })),
    create: (params) => adminClient.optionTypes.create(params),
    update: (id, params) => adminClient.optionTypes.update(id, params),
  },
  categories: { list: (params) => adminClient.categories.list(runtimeListParams(params)) },
  collections: { list: (params) => adminClient.collections.list(runtimeListParams(params)) },
  productTypes: {
    list: (params) => adminClient.productTypes.list(runtimeListParams(params)),
    get: (id) => adminClient.productTypes.get(id),
  },
  // Backs the shared export dialog. `type` is widened to a string by the
  // contract, since a seller's allowlist is a different set from the
  // operator's registry — the API validates it either way.
  exports: {
    create: (params) =>
      adminClient.exports.create(params as Parameters<typeof adminClient.exports.create>[0]),
    get: (id) => adminClient.exports.get(id),
  },
  taxCategories: { list: (params) => adminClient.taxCategories.list(runtimeListParams(params)) },
  deliveryProfiles: {
    list: (params) => adminClient.deliveryProfiles.list(runtimeListParams(params)),
  },
  // Writes as well as reads: the packaging settings page is shared with the
  // seller panel, and its create/edit/delete go through this registration.
  packageTypes: {
    list: (params) => adminClient.packageTypes.list(runtimeListParams(params)),
    get: (id) => adminClient.packageTypes.get(id),
    create: (params) => adminClient.packageTypes.create(params),
    update: (id, params) => adminClient.packageTypes.update(id, params),
    delete: (id) => adminClient.packageTypes.delete(id),
  },
  deleteProductMedia: (productId, mediaId) => adminClient.products.media.delete(productId, mediaId),
  digitalAssets: {
    list: (productId, params) => adminClient.products.digitalAssets.list(productId, params),
    create: (productId, params) => adminClient.products.digitalAssets.create(productId, params),
    update: (productId, id, params) =>
      adminClient.products.digitalAssets.update(productId, id, params),
    delete: (productId, id) => adminClient.products.digitalAssets.delete(productId, id),
    providers: (productId) => adminClient.products.digitalAssets.providers(productId),
  },
  mediaLibrary: { list: (params) => adminClient.media.list(runtimeListParams(params)) },
  tags: {
    list: (params) => adminClient.tags.list(params as { taggable_type: string; q?: string }),
  },
})