bitsnap-payloadcms 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Piotr Michalik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,271 @@
-# Temporary Holding Version
+# bitsnap-payloadcms
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Bitsnap plugin for [Payload CMS 3](https://payloadcms.com) — product sync, an admin product
+manager and a product picker for Payload-based storefronts.
+
+The plugin adds:
+
+- **Bitsnap fields** (`bitsnapID`, `skipSync`, `docUrl`) to the collections you list in `sync`.
+- **Admin components** — a product manager (`BitsnapManager`), a "show in Bitsnap" link
+  (`LinkToDoc`) and a product picker (`ProductSelect`) that all live in the Payload admin.
+- **REST endpoints** that proxy the Bitsnap product API so the admin UI never needs the
+  Bitsnap API key.
+
+## Installation
+
+```bash
+pnpm add bitsnap-payloadcms
+# or
+npm install bitsnap-payloadcms
+```
+
+> **Not on npm yet?** Install the published tarball from the GitHub release:
+>
+> ```bash
+> pnpm add https://github.com/emmems/bitsnap-payloadcms/releases/download/v0.1.1/bitsnap-payloadcms-0.1.1.tgz
+> ```
+
+### 1. Register the plugin
+
+```ts
+// src/payload.config.ts
+import { bitsnapPlugin } from 'bitsnap-payloadcms'
+import { buildConfig } from 'payload'
+
+export default buildConfig({
+  // ...
+  plugins: [
+    bitsnapPlugin({
+      bitsnapApiKey: process.env.BITSNAP_API_KEY ?? '',
+      projectId: process.env.BITSNAP_PROJECT_ID ?? '',
+      currency: 'PLN',
+      sync: [
+        { collection: 'products', fields: [] },
+      ],
+    }),
+  ],
+})
+```
+
+### 2. Regenerate the Payload artefacts — mandatory
+
+The plugin injects fields **and** admin components, so Payload has to pick them up:
+
+```bash
+pnpm generate:importmap   # required — resolves the admin components
+pnpm generate:types       # required — refreshes the generated types
+```
+
+> `generate:importmap` is what maps `bitsnap-payloadcms/client#BitsnapManager` (and the other
+> admin components) to real modules. Without it the admin panel renders the default field
+> instead of the Bitsnap components.
+
+**No `next.config.js` changes are needed.** The plugin is plain Payload config — no
+transpilePackages, no webpack/turbopack tweaks, no `server-only` imports.
+
+## Configuration
+
+| Option         | Type                          | Default                    | Description                                                        |
+| -------------- | ----------------------------- | -------------------------- | ------------------------------------------------------------------ |
+| `bitsnapApiKey` | `string`                     | —                          | Bitsnap API key. Server-side only — it never reaches the browser.  |
+| `projectId`    | `string`                      | `process.env.BITSNAP_PROJECT_ID` | Bitsnap project the products belong to.                      |
+| `dashboardUrl` | `string`                      | `https://bitsnap.pl`       | Base URL of the Bitsnap dashboard.                                 |
+| `apiBasePath`  | `string`                      | `/bitsnap`                 | Path the REST endpoints are mounted on, relative to the API root.  |
+| `currency`     | `string`                      | `PLN`                      | Currency used when creating products and variants.                 |
+| `logs`         | `boolean`                     | `false`                    | Reserved for future use — no behaviour today.        |
+| `sync`         | `SyncConfig[]`                | `[]`                       | Collections that receive the Bitsnap fields. The `fields` mapping is reserved for future use. |
+| `webhooks`     | `BitsnapWebhookHandler \| BitsnapWebhookHandlers` | —             | Reserved for future use — no behaviour today.        |
+
+The endpoints are served relative to Payload's API root (`config.routes.api`, `/api` by default),
+so the default configuration exposes them at `/api/bitsnap/...`.
+
+### Environment variables
+
+| Variable               | Used for                                                        |
+| ---------------------- | --------------------------------------------------------------- |
+| `BITSNAP_API_KEY`      | Fallback API key when `bitsnapApiKey` is not set explicitly.     |
+| `BITSNAP_PROJECT_ID`   | Fallback project id when `projectId` is not set explicitly.     |
+| `CUSTOM_BITSNAP_HOST`  | Points the Bitsnap SDK at a self-hosted Bitsnap instance.        |
+
+## Field helpers
+
+### `bitsnapManagerField(pluginConfig?, overrides?, apiRoute?)`
+
+A `ui` field that renders the Bitsnap product manager. Add it to the collection that holds
+your products:
+
+```ts
+import { bitsnapManagerField } from 'bitsnap-payloadcms'
+
+export const Products: CollectionConfig = {
+  slug: 'products',
+  fields: [
+    { name: 'title', type: 'text' },
+    bitsnapManagerField(),
+  ],
+}
+```
+
+### `productSelectField(pluginConfig?, overrides?, apiRoute?)`
+
+A text field that renders the Bitsnap product picker. Use it in blocks that display a single
+product:
+
+```ts
+import { productSelectField } from 'bitsnap-payloadcms'
+
+export const ProductDetails: Block = {
+  slug: 'productDetails',
+  fields: [productSelectField()],
+}
+```
+
+Both helpers take the plugin configuration as their first argument so the admin components
+receive the same `projectId`, `dashboardUrl` and `currency` the plugin uses:
+
+```ts
+import { bitsnapPluginConfig } from '@/logic/bitsnap'
+
+fields: [bitsnapManagerField(bitsnapPluginConfig)]
+```
+
+`apiRoute` is only needed when the project changed Payload's `config.routes.api` — it defaults
+to `/api`.
+
+### `bitsnapClientConfig(pluginConfig?, apiRoute?)`
+
+Maps a plugin configuration onto the values the admin components receive through
+`clientProps` (`projectId`, `dashboardUrl`, `currency`, `apiBaseUrl`). Use it when you build
+your own admin component and want the same configuration the plugin uses:
+
+```ts
+import { bitsnapClientConfig } from 'bitsnap-payloadcms'
+
+const clientConfig = bitsnapClientConfig({ projectId: 'kL' })
+// { apiBaseUrl: '/api/bitsnap', currency: 'PLN', dashboardUrl: 'https://bitsnap.pl', projectId: 'kL' }
+```
+
+## REST endpoints
+
+All endpoints require an authenticated Payload user and answer with `401` and
+`{ "error": "Brak autoryzacji" }` otherwise.
+
+| Method | Path                          | Description                                    | Body / response                                      |
+| ------ | ----------------------------- | ---------------------------------------------- | ---------------------------------------------------- |
+| `POST` | `/api/bitsnap/products`       | Creates a managed product in Bitsnap.          | body → `{ id, revision }`                           |
+| `GET`  | `/api/bitsnap/products/:id`   | Reads a managed product (incl. its revision).  | response → `{ product }`                            |
+| `PATCH`| `/api/bitsnap/products/:id`   | Patches a managed product in Bitsnap.          | body → `{ id, revision }`                           |
+| `GET`  | `/api/bitsnap/shop-products`  | Lists the products of the project.             | response → the raw Bitsnap envelope, unchanged      |
+
+Request bodies are validated with zod. Invalid bodies answer with `400` and
+`{ "error": "Nieprawidłowe dane żądania" }`.
+
+`POST /api/bitsnap/products`:
+
+```json
+{
+  "name": "Krem nawilżający",
+  "priceAmount": 4999,
+  "priceCurrency": "PLN",
+  "status": "PUBLISHED",
+  "availableQuantity": 12,
+  "variants": [{ "name": "50 ml", "priceAmount": 4999 }]
+}
+```
+
+`priceAmount` and `availableQuantity` are integer minor units (grosze/cents) and must not be
+negative. `priceCurrency` defaults to the currency the plugin was configured with.
+
+`PATCH /api/bitsnap/products/:id` accepts `revision`, `name`, `priceAmount`, `status`,
+`availableQuantity` and `variants`. Pass the `revision` you last read to get optimistic
+concurrency — a mismatch answers with `409` and
+`{ "error": "Produkt zmienił się w Bitsnapie — kliknij Odśwież" }`.
+
+## Server helpers
+
+The server-side helpers are exported as well, so you can build your own routes or jobs:
+
+```ts
+import {
+  configureBitsnapBackend,
+  createManagedProduct,
+  getManagedProduct,
+  getShopProducts,
+  updateManagedProduct,
+} from 'bitsnap-payloadcms'
+
+configureBitsnapBackend({ apiKey: process.env.BITSNAP_API_KEY })
+
+const product = await getManagedProduct('kL', 'product-id')
+const created = await createManagedProduct('kL', { name: 'Krem', priceAmount: 4999, priceCurrency: 'PLN' })
+const updated = await updateManagedProduct('kL', 'product-id', { priceAmount: 5999 })
+const list = await getShopProducts('kL')
+```
+
+The zod schemas used by the endpoints are exported too: `bitsnapStatusSchema`,
+`bitsnapVariantSchema`, `bitsnapCreateSchema` and `bitsnapUpdateSchema`.
+
+## Migrating from the in-repo plugin
+
+If the plugin used to live inside your application (for example
+`src/plugins/plugin-bitsnap/`), you can drop the local copy and use the published package:
+
+1. Delete the local plugin folder and its UI components.
+2. Replace the import in `src/payload.config.ts`:
+
+   ```diff
+   - import { bitsnapPlugin } from '@/plugins/plugin-bitsnap/admin'
+   + import { bitsnapPlugin } from 'bitsnap-payloadcms'
+   ```
+
+3. Replace the local field imports — both helpers are **functions**, so call them with the
+   shared plugin configuration:
+
+   ```diff
+   - import { bitsnapManagerField } from '@/plugins/plugin-bitsnap/fields/getFields'
+   + import { bitsnapManagerField } from 'bitsnap-payloadcms'
+   ```
+
+   ```diff
+   - import { productSelectField } from '@/blocks/_shared/productSelectField'
+   + import { productSelectField } from 'bitsnap-payloadcms'
+   ```
+
+   ```diff
+   - fields: [bitsnapManagerField],
+   + fields: [bitsnapManagerField(bitsnapPluginConfig)],
+   ```
+
+   ```diff
+   - export const productSelectField: Field = { name: 'productID', type: 'text', ... }
+   + export const productSelectField: Field = productSelectField(bitsnapPluginConfig)
+   ```
+
+4. Delete the local API routes under `src/app/api/admin/bitsnap/` — the plugin now registers
+   the same endpoints through `config.endpoints`:
+
+   | Old route                                             | New endpoint            |
+   | ----------------------------------------------------- | ----------------------- |
+   | `POST   /api/admin/bitsnap/products`                  | `POST   /api/bitsnap/products`  |
+   | `GET    /api/admin/bitsnap/products/:id`               | `GET    /api/bitsnap/products/:id` |
+   | `PATCH  /api/admin/bitsnap/products/:id`               | `PATCH  /api/bitsnap/products/:id` |
+   | `GET    /api/admin/bitsnap/shop-products`              | `GET    /api/bitsnap/shop-products` |
+
+   The admin components call the new paths, so no other change is needed.
+
+5. Run `pnpm generate:importmap` and `pnpm generate:types`.
+
+## Publishing
+
+Releases are published to npm by GitHub Actions:
+
+1. Create an npm token with **publish** scope (an automation token or a granular token with the
+   `read-package` + `write-package` permissions).
+2. Add it to the repository as a secret named **`NPM_TOKEN`**.
+3. Publish by creating a GitHub release — or by running the `Publish` workflow manually.
+
+The workflow runs `pnpm build`, then `npm publish --provenance --access public`.
+
+## License
+
+MIT © Piotr Michalik

package/dist/client.d.ts

@@ -0,0 +1,3 @@
+export { BitsnapManager } from './ui/BitsnapManager.js';
+export { LinkToDoc } from './ui/LinkToDoc.js';
+export { ProductSelect } from './ui/ProductSelect.js';

package/dist/client.js

@@ -0,0 +1,5 @@
+export { BitsnapManager } from './ui/BitsnapManager.js';
+export { LinkToDoc } from './ui/LinkToDoc.js';
+export { ProductSelect } from './ui/ProductSelect.js';
+
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"sourcesContent":["export { BitsnapManager } from './ui/BitsnapManager.js'\nexport { LinkToDoc } from './ui/LinkToDoc.js'\nexport { ProductSelect } from './ui/ProductSelect.js'\n"],"names":["BitsnapManager","LinkToDoc","ProductSelect"],"mappings":"AAAA,SAASA,cAAc,QAAQ,yBAAwB;AACvD,SAASC,SAAS,QAAQ,oBAAmB;AAC7C,SAASC,aAAa,QAAQ,wBAAuB"}

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Default values used when the consumer does not override them.
+ */
+export declare const DEFAULT_DASHBOARD_URL = "https://bitsnap.pl";
+export declare const DEFAULT_API_BASE_PATH = "/bitsnap";
+export declare const DEFAULT_CURRENCY = "PLN";
+export declare const DEFAULT_PRODUCTS_LIMIT = 200;

package/dist/constants.js

@@ -0,0 +1,8 @@
+/**
+ * Default values used when the consumer does not override them.
+ */ export const DEFAULT_DASHBOARD_URL = 'https://bitsnap.pl';
+export const DEFAULT_API_BASE_PATH = '/bitsnap';
+export const DEFAULT_CURRENCY = 'PLN';
+export const DEFAULT_PRODUCTS_LIMIT = 200;
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["/**\n * Default values used when the consumer does not override them.\n */\nexport const DEFAULT_DASHBOARD_URL = 'https://bitsnap.pl'\n\nexport const DEFAULT_API_BASE_PATH = '/bitsnap'\n\nexport const DEFAULT_CURRENCY = 'PLN'\n\nexport const DEFAULT_PRODUCTS_LIMIT = 200\n"],"names":["DEFAULT_DASHBOARD_URL","DEFAULT_API_BASE_PATH","DEFAULT_CURRENCY","DEFAULT_PRODUCTS_LIMIT"],"mappings":"AAAA;;CAEC,GACD,OAAO,MAAMA,wBAAwB,qBAAoB;AAEzD,OAAO,MAAMC,wBAAwB,WAAU;AAE/C,OAAO,MAAMC,mBAAmB,MAAK;AAErC,OAAO,MAAMC,yBAAyB,IAAG"}

package/dist/fields/getFields.d.ts

@@ -0,0 +1,54 @@
+import type { CollectionConfig, Field } from 'payload';
+import type { BitsnapClientConfig, BitsnapPluginConfig, SanitizedBitsnapPluginConfig, SyncConfig } from '../types.js';
+/**
+ * Import-map paths of the admin components shipped with this package.
+ *
+ * Payload resolves these strings through the generated import map, so the
+ * consumer has to run `payload generate:importmap` after installing the plugin.
+ */
+export declare const BITSNAP_MANAGER_COMPONENT_PATH = "bitsnap-payloadcms/client#BitsnapManager";
+export declare const BITSNAP_LINK_TO_DOC_COMPONENT_PATH = "bitsnap-payloadcms/client#LinkToDoc";
+export declare const BITSNAP_PRODUCT_SELECT_COMPONENT_PATH = "bitsnap-payloadcms/client#ProductSelect";
+/**
+ * Default Payload REST API root. Mirrors Payload's own `config.routes.api` default.
+ */
+export declare const DEFAULT_API_ROUTE = "/api";
+export type GetFieldsArgs = {
+    /**
+     * Payload REST API root, e.g. `/api`. Used to build the absolute path of the
+     * plugin endpoints that the admin components call.
+     */
+    apiRoute?: string;
+    collection: CollectionConfig;
+    pluginConfig: SanitizedBitsnapPluginConfig;
+    syncConfig: SyncConfig;
+};
+/**
+ * Maps a plugin configuration onto the values the admin components need.
+ *
+ * Only non-secret values end up here — the API key is never part of the
+ * client configuration.
+ */
+export declare function bitsnapClientConfig(pluginConfig?: Partial<BitsnapPluginConfig>, apiRoute?: string): BitsnapClientConfig;
+/**
+ * `ui` field that renders the Bitsnap product manager inside the Payload admin.
+ *
+ * `apiRoute` is only needed when the consuming project changed Payload's
+ * `config.routes.api` — it defaults to `/api`.
+ */
+export declare function bitsnapManagerField(pluginConfig?: Partial<BitsnapPluginConfig>, overrides?: Partial<Field>, apiRoute?: string): Field;
+/**
+ * Text field that renders the Bitsnap product picker. Meant for blocks that
+ * display a single Bitsnap product.
+ *
+ * `apiRoute` is only needed when the consuming project changed Payload's
+ * `config.routes.api` — it defaults to `/api`.
+ */
+export declare function productSelectField(pluginConfig?: Partial<BitsnapPluginConfig>, overrides?: Partial<Field>, apiRoute?: string): Field;
+/**
+ * Fields the plugin appends to every collection listed in `sync`.
+ *
+ * The collection's own fields are never replaced — the Bitsnap fields are
+ * appended so the collection keeps its own schema intact.
+ */
+export declare function getFields({ apiRoute, collection, pluginConfig, syncConfig, }: GetFieldsArgs): Field[];

package/dist/fields/getFields.js

@@ -0,0 +1,150 @@
+import { DEFAULT_API_BASE_PATH, DEFAULT_CURRENCY, DEFAULT_DASHBOARD_URL } from '../constants.js';
+/**
+ * Import-map paths of the admin components shipped with this package.
+ *
+ * Payload resolves these strings through the generated import map, so the
+ * consumer has to run `payload generate:importmap` after installing the plugin.
+ */ export const BITSNAP_MANAGER_COMPONENT_PATH = 'bitsnap-payloadcms/client#BitsnapManager';
+export const BITSNAP_LINK_TO_DOC_COMPONENT_PATH = 'bitsnap-payloadcms/client#LinkToDoc';
+export const BITSNAP_PRODUCT_SELECT_COMPONENT_PATH = 'bitsnap-payloadcms/client#ProductSelect';
+/**
+ * Default Payload REST API root. Mirrors Payload's own `config.routes.api` default.
+ */ export const DEFAULT_API_ROUTE = '/api';
+/**
+ * Maps a plugin configuration onto the values the admin components need.
+ *
+ * Only non-secret values end up here — the API key is never part of the
+ * client configuration.
+ */ export function bitsnapClientConfig(pluginConfig, apiRoute = DEFAULT_API_ROUTE) {
+    const apiBasePath = pluginConfig?.apiBasePath ?? DEFAULT_API_BASE_PATH;
+    const currency = pluginConfig?.currency ?? DEFAULT_CURRENCY;
+    const dashboardUrl = pluginConfig?.dashboardUrl ?? DEFAULT_DASHBOARD_URL;
+    const projectId = pluginConfig?.projectId ?? process.env.BITSNAP_PROJECT_ID ?? '';
+    const normalizedApiRoute = apiRoute.endsWith('/') ? apiRoute.slice(0, -1) : apiRoute;
+    return {
+        apiBaseUrl: `${normalizedApiRoute}${apiBasePath}`,
+        currency,
+        dashboardUrl,
+        projectId
+    };
+}
+/**
+ * `ui` field that renders the Bitsnap product manager inside the Payload admin.
+ *
+ * `apiRoute` is only needed when the consuming project changed Payload's
+ * `config.routes.api` — it defaults to `/api`.
+ */ export function bitsnapManagerField(pluginConfig, overrides, apiRoute) {
+    const field = {
+        name: 'bitsnapManager',
+        type: 'ui',
+        label: {
+            en: 'Product in Bitsnap',
+            pl: 'Produkt w Bitsnap'
+        },
+        admin: {
+            components: {
+                Field: {
+                    path: BITSNAP_MANAGER_COMPONENT_PATH,
+                    clientProps: bitsnapClientConfig(pluginConfig, apiRoute)
+                }
+            }
+        }
+    };
+    return applyOverrides(field, overrides);
+}
+/**
+ * Text field that renders the Bitsnap product picker. Meant for blocks that
+ * display a single Bitsnap product.
+ *
+ * `apiRoute` is only needed when the consuming project changed Payload's
+ * `config.routes.api` — it defaults to `/api`.
+ */ export function productSelectField(pluginConfig, overrides, apiRoute) {
+    const field = {
+        name: 'productID',
+        type: 'text',
+        label: {
+            en: 'Product',
+            pl: 'Produkt'
+        },
+        admin: {
+            components: {
+                Field: {
+                    path: BITSNAP_PRODUCT_SELECT_COMPONENT_PATH,
+                    clientProps: bitsnapClientConfig(pluginConfig, apiRoute)
+                }
+            },
+            description: {
+                en: 'Bitsnap product shown by this block.',
+                pl: 'Produkt Bitsnap wyświetlany w tym bloku.'
+            },
+            readOnly: false
+        },
+        required: false
+    };
+    return applyOverrides(field, overrides);
+}
+/**
+ * Fields the plugin appends to every collection listed in `sync`.
+ *
+ * The collection's own fields are never replaced — the Bitsnap fields are
+ * appended so the collection keeps its own schema intact.
+ */ export function getFields({ apiRoute, collection, pluginConfig, syncConfig }) {
+    const bitsnapIDField = {
+        name: 'bitsnapID',
+        type: 'text',
+        admin: {
+            position: 'sidebar',
+            readOnly: true
+        },
+        label: {
+            en: 'Bitsnap Product Id',
+            pl: 'ID produktu Bitsnap'
+        },
+        saveToJWT: true
+    };
+    const skipSyncField = {
+        name: 'skipSync',
+        type: 'checkbox',
+        admin: {
+            position: 'sidebar',
+            readOnly: true
+        },
+        label: {
+            en: 'Skip Sync',
+            pl: 'Pomiń synchronizację'
+        }
+    };
+    const docUrlField = {
+        name: 'docUrl',
+        type: 'ui',
+        admin: {
+            components: {
+                Field: {
+                    path: BITSNAP_LINK_TO_DOC_COMPONENT_PATH,
+                    clientProps: bitsnapClientConfig(pluginConfig, apiRoute)
+                }
+            },
+            custom: {
+                nameOfIDField: 'bitsnapID'
+            },
+            position: 'sidebar'
+        }
+    };
+    // The sync mapping itself is applied by the sync job — the plugin only adds
+    // the fields the admin UI needs.
+    void syncConfig;
+    return [
+        ...collection.fields,
+        bitsnapIDField,
+        skipSyncField,
+        docUrlField
+    ];
+}
+function applyOverrides(field, overrides) {
+    if (!overrides) {
+        return field;
+    }
+    return Object.assign(field, overrides);
+}
+
+//# sourceMappingURL=getFields.js.map

package/dist/fields/getFields.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/fields/getFields.ts"],"sourcesContent":["import type { CollectionConfig, Field } from 'payload'\n\nimport {\n  DEFAULT_API_BASE_PATH,\n  DEFAULT_CURRENCY,\n  DEFAULT_DASHBOARD_URL,\n} from '../constants.js'\nimport type {\n  BitsnapClientConfig,\n  BitsnapPluginConfig,\n  SanitizedBitsnapPluginConfig,\n  SyncConfig,\n} from '../types.js'\n\n/**\n * Import-map paths of the admin components shipped with this package.\n *\n * Payload resolves these strings through the generated import map, so the\n * consumer has to run `payload generate:importmap` after installing the plugin.\n */\nexport const BITSNAP_MANAGER_COMPONENT_PATH = 'bitsnap-payloadcms/client#BitsnapManager'\nexport const BITSNAP_LINK_TO_DOC_COMPONENT_PATH = 'bitsnap-payloadcms/client#LinkToDoc'\nexport const BITSNAP_PRODUCT_SELECT_COMPONENT_PATH = 'bitsnap-payloadcms/client#ProductSelect'\n\n/**\n * Default Payload REST API root. Mirrors Payload's own `config.routes.api` default.\n */\nexport const DEFAULT_API_ROUTE = '/api'\n\nexport type GetFieldsArgs = {\n  /**\n   * Payload REST API root, e.g. `/api`. Used to build the absolute path of the\n   * plugin endpoints that the admin components call.\n   */\n  apiRoute?: string\n  collection: CollectionConfig\n  pluginConfig: SanitizedBitsnapPluginConfig\n  syncConfig: SyncConfig\n}\n\n/**\n * Maps a plugin configuration onto the values the admin components need.\n *\n * Only non-secret values end up here — the API key is never part of the\n * client configuration.\n */\nexport function bitsnapClientConfig(\n  pluginConfig?: Partial<BitsnapPluginConfig>,\n  apiRoute: string = DEFAULT_API_ROUTE,\n): BitsnapClientConfig {\n  const apiBasePath = pluginConfig?.apiBasePath ?? DEFAULT_API_BASE_PATH\n  const currency = pluginConfig?.currency ?? DEFAULT_CURRENCY\n  const dashboardUrl = pluginConfig?.dashboardUrl ?? DEFAULT_DASHBOARD_URL\n  const projectId = pluginConfig?.projectId ?? process.env.BITSNAP_PROJECT_ID ?? ''\n  const normalizedApiRoute = apiRoute.endsWith('/') ? apiRoute.slice(0, -1) : apiRoute\n\n  return {\n    apiBaseUrl: `${normalizedApiRoute}${apiBasePath}`,\n    currency,\n    dashboardUrl,\n    projectId,\n  }\n}\n\n/**\n * `ui` field that renders the Bitsnap product manager inside the Payload admin.\n *\n * `apiRoute` is only needed when the consuming project changed Payload's\n * `config.routes.api` — it defaults to `/api`.\n */\nexport function bitsnapManagerField(\n  pluginConfig?: Partial<BitsnapPluginConfig>,\n  overrides?: Partial<Field>,\n  apiRoute?: string,\n): Field {\n  const field: Field = {\n    name: 'bitsnapManager',\n    type: 'ui',\n    label: { en: 'Product in Bitsnap', pl: 'Produkt w Bitsnap' },\n    admin: {\n      components: {\n        Field: {\n          path: BITSNAP_MANAGER_COMPONENT_PATH,\n          clientProps: bitsnapClientConfig(pluginConfig, apiRoute),\n        },\n      },\n    },\n  }\n\n  return applyOverrides(field, overrides)\n}\n\n/**\n * Text field that renders the Bitsnap product picker. Meant for blocks that\n * display a single Bitsnap product.\n *\n * `apiRoute` is only needed when the consuming project changed Payload's\n * `config.routes.api` — it defaults to `/api`.\n */\nexport function productSelectField(\n  pluginConfig?: Partial<BitsnapPluginConfig>,\n  overrides?: Partial<Field>,\n  apiRoute?: string,\n): Field {\n  const field: Field = {\n    name: 'productID',\n    type: 'text',\n    label: { en: 'Product', pl: 'Produkt' },\n    admin: {\n      components: {\n        Field: {\n          path: BITSNAP_PRODUCT_SELECT_COMPONENT_PATH,\n          clientProps: bitsnapClientConfig(pluginConfig, apiRoute),\n        },\n      },\n      description: {\n        en: 'Bitsnap product shown by this block.',\n        pl: 'Produkt Bitsnap wyświetlany w tym bloku.',\n      },\n      readOnly: false,\n    },\n    required: false,\n  }\n\n  return applyOverrides(field, overrides)\n}\n\n/**\n * Fields the plugin appends to every collection listed in `sync`.\n *\n * The collection's own fields are never replaced — the Bitsnap fields are\n * appended so the collection keeps its own schema intact.\n */\nexport function getFields({\n  apiRoute,\n  collection,\n  pluginConfig,\n  syncConfig,\n}: GetFieldsArgs): Field[] {\n  const bitsnapIDField: Field = {\n    name: 'bitsnapID',\n    type: 'text',\n    admin: {\n      position: 'sidebar',\n      readOnly: true,\n    },\n    label: { en: 'Bitsnap Product Id', pl: 'ID produktu Bitsnap' },\n    saveToJWT: true,\n  }\n\n  const skipSyncField: Field = {\n    name: 'skipSync',\n    type: 'checkbox',\n    admin: {\n      position: 'sidebar',\n      readOnly: true,\n    },\n    label: { en: 'Skip Sync', pl: 'Pomiń synchronizację' },\n  }\n\n  const docUrlField: Field = {\n    name: 'docUrl',\n    type: 'ui',\n    admin: {\n      components: {\n        Field: {\n          path: BITSNAP_LINK_TO_DOC_COMPONENT_PATH,\n          clientProps: bitsnapClientConfig(pluginConfig, apiRoute),\n        },\n      },\n      custom: {\n        nameOfIDField: 'bitsnapID',\n      },\n      position: 'sidebar',\n    },\n  }\n\n  // The sync mapping itself is applied by the sync job — the plugin only adds\n  // the fields the admin UI needs.\n  void syncConfig\n\n  return [...collection.fields, bitsnapIDField, skipSyncField, docUrlField]\n}\n\nfunction applyOverrides(field: Field, overrides?: Partial<Field>): Field {\n  if (!overrides) {\n    return field\n  }\n\n  return Object.assign(field, overrides)\n}\n"],"names":["DEFAULT_API_BASE_PATH","DEFAULT_CURRENCY","DEFAULT_DASHBOARD_URL","BITSNAP_MANAGER_COMPONENT_PATH","BITSNAP_LINK_TO_DOC_COMPONENT_PATH","BITSNAP_PRODUCT_SELECT_COMPONENT_PATH","DEFAULT_API_ROUTE","bitsnapClientConfig","pluginConfig","apiRoute","apiBasePath","currency","dashboardUrl","projectId","process","env","BITSNAP_PROJECT_ID","normalizedApiRoute","endsWith","slice","apiBaseUrl","bitsnapManagerField","overrides","field","name","type","label","en","pl","admin","components","Field","path","clientProps","applyOverrides","productSelectField","description","readOnly","required","getFields","collection","syncConfig","bitsnapIDField","position","saveToJWT","skipSyncField","docUrlField","custom","nameOfIDField","fields","Object","assign"],"mappings":"AAEA,SACEA,qBAAqB,EACrBC,gBAAgB,EAChBC,qBAAqB,QAChB,kBAAiB;AAQxB;;;;;CAKC,GACD,OAAO,MAAMC,iCAAiC,2CAA0C;AACxF,OAAO,MAAMC,qCAAqC,sCAAqC;AACvF,OAAO,MAAMC,wCAAwC,0CAAyC;AAE9F;;CAEC,GACD,OAAO,MAAMC,oBAAoB,OAAM;AAavC;;;;;CAKC,GACD,OAAO,SAASC,oBACdC,YAA2C,EAC3CC,WAAmBH,iBAAiB;IAEpC,MAAMI,cAAcF,cAAcE,eAAeV;IACjD,MAAMW,WAAWH,cAAcG,YAAYV;IAC3C,MAAMW,eAAeJ,cAAcI,gBAAgBV;IACnD,MAAMW,YAAYL,cAAcK,aAAaC,QAAQC,GAAG,CAACC,kBAAkB,IAAI;IAC/E,MAAMC,qBAAqBR,SAASS,QAAQ,CAAC,OAAOT,SAASU,KAAK,CAAC,GAAG,CAAC,KAAKV;IAE5E,OAAO;QACLW,YAAY,GAAGH,qBAAqBP,aAAa;QACjDC;QACAC;QACAC;IACF;AACF;AAEA;;;;;CAKC,GACD,OAAO,SAASQ,oBACdb,YAA2C,EAC3Cc,SAA0B,EAC1Bb,QAAiB;IAEjB,MAAMc,QAAe;QACnBC,MAAM;QACNC,MAAM;QACNC,OAAO;YAAEC,IAAI;YAAsBC,IAAI;QAAoB;QAC3DC,OAAO;YACLC,YAAY;gBACVC,OAAO;oBACLC,MAAM7B;oBACN8B,aAAa1B,oBAAoBC,cAAcC;gBACjD;YACF;QACF;IACF;IAEA,OAAOyB,eAAeX,OAAOD;AAC/B;AAEA;;;;;;CAMC,GACD,OAAO,SAASa,mBACd3B,YAA2C,EAC3Cc,SAA0B,EAC1Bb,QAAiB;IAEjB,MAAMc,QAAe;QACnBC,MAAM;QACNC,MAAM;QACNC,OAAO;YAAEC,IAAI;YAAWC,IAAI;QAAU;QACtCC,OAAO;YACLC,YAAY;gBACVC,OAAO;oBACLC,MAAM3B;oBACN4B,aAAa1B,oBAAoBC,cAAcC;gBACjD;YACF;YACA2B,aAAa;gBACXT,IAAI;gBACJC,IAAI;YACN;YACAS,UAAU;QACZ;QACAC,UAAU;IACZ;IAEA,OAAOJ,eAAeX,OAAOD;AAC/B;AAEA;;;;;CAKC,GACD,OAAO,SAASiB,UAAU,EACxB9B,QAAQ,EACR+B,UAAU,EACVhC,YAAY,EACZiC,UAAU,EACI;IACd,MAAMC,iBAAwB;QAC5BlB,MAAM;QACNC,MAAM;QACNI,OAAO;YACLc,UAAU;YACVN,UAAU;QACZ;QACAX,OAAO;YAAEC,IAAI;YAAsBC,IAAI;QAAsB;QAC7DgB,WAAW;IACb;IAEA,MAAMC,gBAAuB;QAC3BrB,MAAM;QACNC,MAAM;QACNI,OAAO;YACLc,UAAU;YACVN,UAAU;QACZ;QACAX,OAAO;YAAEC,IAAI;YAAaC,IAAI;QAAuB;IACvD;IAEA,MAAMkB,cAAqB;QACzBtB,MAAM;QACNC,MAAM;QACNI,OAAO;YACLC,YAAY;gBACVC,OAAO;oBACLC,MAAM5B;oBACN6B,aAAa1B,oBAAoBC,cAAcC;gBACjD;YACF;YACAsC,QAAQ;gBACNC,eAAe;YACjB;YACAL,UAAU;QACZ;IACF;IAEA,4EAA4E;IAC5E,iCAAiC;IACjC,KAAKF;IAEL,OAAO;WAAID,WAAWS,MAAM;QAAEP;QAAgBG;QAAeC;KAAY;AAC3E;AAEA,SAASZ,eAAeX,KAAY,EAAED,SAA0B;IAC9D,IAAI,CAACA,WAAW;QACd,OAAOC;IACT;IAEA,OAAO2B,OAAOC,MAAM,CAAC5B,OAAOD;AAC9B"}

package/dist/fields/index.d.ts

@@ -0,0 +1,2 @@
+export { BITSNAP_LINK_TO_DOC_COMPONENT_PATH, BITSNAP_MANAGER_COMPONENT_PATH, BITSNAP_PRODUCT_SELECT_COMPONENT_PATH, DEFAULT_API_ROUTE, bitsnapClientConfig, bitsnapManagerField, getFields, productSelectField, } from './getFields.js';
+export type { GetFieldsArgs } from './getFields.js';

package/dist/fields/index.js

@@ -0,0 +1,3 @@
+export { BITSNAP_LINK_TO_DOC_COMPONENT_PATH, BITSNAP_MANAGER_COMPONENT_PATH, BITSNAP_PRODUCT_SELECT_COMPONENT_PATH, DEFAULT_API_ROUTE, bitsnapClientConfig, bitsnapManagerField, getFields, productSelectField } from './getFields.js';
+
+//# sourceMappingURL=index.js.map

package/dist/fields/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/fields/index.ts"],"sourcesContent":["export {\n  BITSNAP_LINK_TO_DOC_COMPONENT_PATH,\n  BITSNAP_MANAGER_COMPONENT_PATH,\n  BITSNAP_PRODUCT_SELECT_COMPONENT_PATH,\n  DEFAULT_API_ROUTE,\n  bitsnapClientConfig,\n  bitsnapManagerField,\n  getFields,\n  productSelectField,\n} from './getFields.js'\nexport type { GetFieldsArgs } from './getFields.js'\n"],"names":["BITSNAP_LINK_TO_DOC_COMPONENT_PATH","BITSNAP_MANAGER_COMPONENT_PATH","BITSNAP_PRODUCT_SELECT_COMPONENT_PATH","DEFAULT_API_ROUTE","bitsnapClientConfig","bitsnapManagerField","getFields","productSelectField"],"mappings":"AAAA,SACEA,kCAAkC,EAClCC,8BAA8B,EAC9BC,qCAAqC,EACrCC,iBAAiB,EACjBC,mBAAmB,EACnBC,mBAAmB,EACnBC,SAAS,EACTC,kBAAkB,QACb,iBAAgB"}

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export { BITSNAP_LINK_TO_DOC_COMPONENT_PATH, BITSNAP_MANAGER_COMPONENT_PATH, BITSNAP_PRODUCT_SELECT_COMPONENT_PATH, DEFAULT_API_ROUTE, bitsnapClientConfig, bitsnapManagerField, getFields, productSelectField, } from './fields/index.js';
+export type { GetFieldsArgs } from './fields/index.js';
+export { bitsnapPlugin, sanitizeBitsnapPluginConfig } from './plugin.js';
+export { bitsnapCreateSchema, bitsnapErrorMessage, bitsnapErrorResponse, bitsnapStatusSchema, bitsnapUpdateSchema, bitsnapVariantSchema, configureBitsnapBackend, createBitsnapEndpoints, createManagedProduct, getBitsnapCurrency, getManagedProduct, getShopProducts, isBitsnapApiKeyConfigured, resolveBitsnapApiKey, setBitsnapCurrency, updateManagedProduct, } from './server/index.js';
+export type { BitsnapCreateInput, BitsnapStatus, BitsnapUpdateInput, BitsnapVariantInput, ConfigureBitsnapBackendArgs, ShopProductsResult, } from './server/index.js';
+export { DEFAULT_API_BASE_PATH, DEFAULT_CURRENCY, DEFAULT_DASHBOARD_URL, DEFAULT_PRODUCTS_LIMIT, } from './constants.js';
+export type { BitsnapClientConfig, BitsnapPluginConfig, BitsnapProxy, BitsnapWebhookHandler, BitsnapWebhookHandlers, FieldSyncConfig, SanitizedBitsnapPluginConfig, SyncConfig, } from './types.js';

package/dist/index.js

@@ -0,0 +1,6 @@
+export { BITSNAP_LINK_TO_DOC_COMPONENT_PATH, BITSNAP_MANAGER_COMPONENT_PATH, BITSNAP_PRODUCT_SELECT_COMPONENT_PATH, DEFAULT_API_ROUTE, bitsnapClientConfig, bitsnapManagerField, getFields, productSelectField } from './fields/index.js';
+export { bitsnapPlugin, sanitizeBitsnapPluginConfig } from './plugin.js';
+export { bitsnapCreateSchema, bitsnapErrorMessage, bitsnapErrorResponse, bitsnapStatusSchema, bitsnapUpdateSchema, bitsnapVariantSchema, configureBitsnapBackend, createBitsnapEndpoints, createManagedProduct, getBitsnapCurrency, getManagedProduct, getShopProducts, isBitsnapApiKeyConfigured, resolveBitsnapApiKey, setBitsnapCurrency, updateManagedProduct } from './server/index.js';
+export { DEFAULT_API_BASE_PATH, DEFAULT_CURRENCY, DEFAULT_DASHBOARD_URL, DEFAULT_PRODUCTS_LIMIT } from './constants.js';
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export {\n  BITSNAP_LINK_TO_DOC_COMPONENT_PATH,\n  BITSNAP_MANAGER_COMPONENT_PATH,\n  BITSNAP_PRODUCT_SELECT_COMPONENT_PATH,\n  DEFAULT_API_ROUTE,\n  bitsnapClientConfig,\n  bitsnapManagerField,\n  getFields,\n  productSelectField,\n} from './fields/index.js'\nexport type { GetFieldsArgs } from './fields/index.js'\nexport { bitsnapPlugin, sanitizeBitsnapPluginConfig } from './plugin.js'\nexport {\n  bitsnapCreateSchema,\n  bitsnapErrorMessage,\n  bitsnapErrorResponse,\n  bitsnapStatusSchema,\n  bitsnapUpdateSchema,\n  bitsnapVariantSchema,\n  configureBitsnapBackend,\n  createBitsnapEndpoints,\n  createManagedProduct,\n  getBitsnapCurrency,\n  getManagedProduct,\n  getShopProducts,\n  isBitsnapApiKeyConfigured,\n  resolveBitsnapApiKey,\n  setBitsnapCurrency,\n  updateManagedProduct,\n} from './server/index.js'\nexport type {\n  BitsnapCreateInput,\n  BitsnapStatus,\n  BitsnapUpdateInput,\n  BitsnapVariantInput,\n  ConfigureBitsnapBackendArgs,\n  ShopProductsResult,\n} from './server/index.js'\nexport {\n  DEFAULT_API_BASE_PATH,\n  DEFAULT_CURRENCY,\n  DEFAULT_DASHBOARD_URL,\n  DEFAULT_PRODUCTS_LIMIT,\n} from './constants.js'\nexport type {\n  BitsnapClientConfig,\n  BitsnapPluginConfig,\n  BitsnapProxy,\n  BitsnapWebhookHandler,\n  BitsnapWebhookHandlers,\n  FieldSyncConfig,\n  SanitizedBitsnapPluginConfig,\n  SyncConfig,\n} from './types.js'\n"],"names":["BITSNAP_LINK_TO_DOC_COMPONENT_PATH","BITSNAP_MANAGER_COMPONENT_PATH","BITSNAP_PRODUCT_SELECT_COMPONENT_PATH","DEFAULT_API_ROUTE","bitsnapClientConfig","bitsnapManagerField","getFields","productSelectField","bitsnapPlugin","sanitizeBitsnapPluginConfig","bitsnapCreateSchema","bitsnapErrorMessage","bitsnapErrorResponse","bitsnapStatusSchema","bitsnapUpdateSchema","bitsnapVariantSchema","configureBitsnapBackend","createBitsnapEndpoints","createManagedProduct","getBitsnapCurrency","getManagedProduct","getShopProducts","isBitsnapApiKeyConfigured","resolveBitsnapApiKey","setBitsnapCurrency","updateManagedProduct","DEFAULT_API_BASE_PATH","DEFAULT_CURRENCY","DEFAULT_DASHBOARD_URL","DEFAULT_PRODUCTS_LIMIT"],"mappings":"AAAA,SACEA,kCAAkC,EAClCC,8BAA8B,EAC9BC,qCAAqC,EACrCC,iBAAiB,EACjBC,mBAAmB,EACnBC,mBAAmB,EACnBC,SAAS,EACTC,kBAAkB,QACb,oBAAmB;AAE1B,SAASC,aAAa,EAAEC,2BAA2B,QAAQ,cAAa;AACxE,SACEC,mBAAmB,EACnBC,mBAAmB,EACnBC,oBAAoB,EACpBC,mBAAmB,EACnBC,mBAAmB,EACnBC,oBAAoB,EACpBC,uBAAuB,EACvBC,sBAAsB,EACtBC,oBAAoB,EACpBC,kBAAkB,EAClBC,iBAAiB,EACjBC,eAAe,EACfC,yBAAyB,EACzBC,oBAAoB,EACpBC,kBAAkB,EAClBC,oBAAoB,QACf,oBAAmB;AAS1B,SACEC,qBAAqB,EACrBC,gBAAgB,EAChBC,qBAAqB,EACrBC,sBAAsB,QACjB,iBAAgB"}

package/dist/plugin.d.ts

@@ -0,0 +1,15 @@
+import type { Plugin } from 'payload';
+import type { BitsnapPluginConfig, SanitizedBitsnapPluginConfig } from './types.js';
+/**
+ * Fills in every default the plugin needs so the rest of the code can rely on
+ * a fully populated configuration.
+ */
+export declare function sanitizeBitsnapPluginConfig(pluginConfig: BitsnapPluginConfig): SanitizedBitsnapPluginConfig;
+/**
+ * Payload plugin that wires Bitsnap into a Payload project.
+ *
+ * - appends the Bitsnap fields to every collection listed in `sync`
+ * - mounts the Bitsnap REST endpoints on the Payload API root
+ * - points the Bitsnap SDK at the configured host and API key
+ */
+export declare const bitsnapPlugin: (pluginConfig: BitsnapPluginConfig) => Plugin;