@fakeware/plugin-pickware 0.0.1 → 1.0.0

package/README.md

@@ -2,139 +2,3 @@
 
 A [fakeware](https://github.com/fakeware-sh/fakeware) plugin for **Pickware ERP** —
 seed warehouses, bin locations, and stock into a Shopware 6 shop running Pickware.
-
-It teaches fakeware about Pickware's DAL entities so you can author them with
-`define(...)` in your data files, and contributes a fetcher that loads the shop's
-existing warehouses into the run context.
-
-> **Status: minimal v1.** Covers `pickware_erp_warehouse`, `pickware_erp_bin_location`,
-> and `pickware_erp_stock_movement`. Suppliers, purchasing, stocktakes, and the
-> WMS/POS/Shipping entities are intentionally out of scope for now.
-
-## Install
-
-```sh
-bun add -D @fakeware/plugin-pickware
-# @fakeware/core is a peer dependency — your fakeware project already has it.
-```
-
-## Usage
-
-Register the plugin in `fakeware.config.ts`:
-
-```ts
-import { defineConfig } from '@fakeware/core/config'
-import { pickware } from '@fakeware/plugin-pickware'
-
-export default defineConfig({
-  shopware: {
-    url: process.env.SHOPWARE_URL!,
-    clientId: process.env.SHOPWARE_CLIENT_ID!,
-    clientSecret: process.env.SHOPWARE_CLIENT_SECRET!,
-  },
-  plugins: [pickware()],
-})
-```
-
-Author Pickware data in `data/*.ts`. Importing the package augments fakeware's
-`EntityRegistry`, so the `pickware_erp_*` entity names are fully type-checked:
-
-`data/pickware.ts`:
-
-```ts
-import { define, ref } from '@fakeware/core'
-import { stockMovementIn } from '@fakeware/plugin-pickware'
-
-define('pickware_erp_warehouse', { $key: 'main', name: 'Main', code: 'WH-01' })
-
-define('pickware_erp_bin_location', {
-  $key: 'a1',
-  code: 'A1',
-  warehouseId: ref('pickware_erp_warehouse/main'),
-})
-
-define(
-  'pickware_erp_stock_movement',
-  stockMovementIn({
-    productId: ref('product/my-product'),
-    warehouseId: ref('pickware_erp_warehouse/main'),
-    quantity: 100,
-  }),
-)
-```
-
-Bin locations referencing a warehouse via `ref()` are written after it
-automatically. Seed stock through `pickware_erp_stock_movement` (an append-only
-ledger) — never write `product.stock` directly while Pickware is active.
-
-Run it with the fakeware CLI:
-
-```sh
-fakeware up --dry-run
-fakeware up
-```
-
-### Referencing existing warehouses
-
-`pickware()` adds a fetcher that loads the shop's current warehouses into the run
-context. Read them in a plugin `setup` hook or any code with access to the context:
-
-```ts
-import { pickwareWarehouses } from '@fakeware/plugin-pickware'
-
-const existing = pickwareWarehouses(shopContext.extensions)
-const main = existing.find((w) => w.code === 'WH-01')
-```
-
-## ⚠️ Verify field names against your install
-
-Pickware publishes **no Shopware 6 API documentation**, so the entity *field
-names* in this plugin (especially `destinationWarehouseId` on the stock movement)
-are best-effort. **Before a live `up`, confirm them against your shop:**
-
-```sh
-curl -H "Authorization: Bearer <token>" \
-  https://your-shop.example/api/_info/entity-schema.json \
-  | jq 'keys | map(select(startswith("pickware_erp")))'
-```
-
-Inspect the `pickware_erp_warehouse`, `pickware_erp_bin_location`, and
-`pickware_erp_stock_movement` field definitions there (or watch the Pickware
-admin module's network requests) and adjust the record shapes in
-`src/entities.ts` / the `stockMovementIn` helper to match.
-
-Key facts the plugin is built around:
-
-- Stock is owned by Pickware's **append-only ledger** (`pickware_erp_stock_movement`).
-  You change stock by **adding movements**; Pickware recomputes
-  `pickware_erp_stock` and mirrors the total back into `product.stock`.
-- Writing `product.stock` directly via the standard API while Pickware is active
-  **nulls** the Pickware warehouses — don't do it.
-
-## Publishing
-
-This repo publishes `@fakeware/plugin-pickware` to npm via
-[release-please](https://github.com/googleapis/release-please) — the same flow as
-the fakeware monorepo. Conventional commits on `main` open a release PR; merging
-it tags a version and publishes.
-
-**One-time repo setup** (in GitHub → Settings):
-
-- Add an npm publish credential for the `@fakeware` scope. The release workflow
-  uses npm provenance (`id-token: write`) — configure a trusted publisher on npm,
-  or add an `NPM_TOKEN` secret and wire it into `.github/workflows/release.yml`.
-- The default `GITHUB_TOKEN` is sufficient for release-please's PR/tagging.
-
-## Development
-
-```sh
-bun install
-bun run build
-bun run typecheck
-bun test
-bun run check
-```
-
-## License
-
-MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fakeware/plugin-pickware",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "Pickware ERP plugin for fakeware. Seed warehouses, bin locations and stock into a Shopware 6 shop running Pickware",
   "type": "module",
   "license": "MIT",