kempo-inventory 0.3.5 → 0.4.0

package/README.md

@@ -2,7 +2,7 @@
 
 The core of an inventory system for [kempo](https://www.npmjs.com/package/kempo) CMS. It is deliberately small: every item has just a **SKU**, **name**, **quantity** and **description**. Everything else is a *custom field* that a person adds in the admin, or that another extension registers, so the same base can model anything: parts, books, rentals, supplies.
 
-- Stock changes go through one audited action, with a reason, a note and a movement history
+- Quantity changes go through one audited action, with a reason, a note and a movement history
 - Custom fields of seven types, managed in **Admin > Inventory > Fields**
 - A server SDK and a set of hooks so other extensions can extend it (reorder levels, pricing, suppliers, categories...), and fields, categories and items can be owned by an extension
 - Admin page at **Admin > Inventory**, JSON API under `/inventory/api`
@@ -77,15 +77,15 @@ A photo field (type "Photos / files") can **force how photos are saved**. When y
 - **Force photo shape**: an aspect ratio such as `1:1`, `4:3` or `16:9`. Each photo added to the field opens in Kempo UI's `<k-image-crop>`, locked to that shape, so only that shape can be saved; **Skip** leaves a photo out.
 - **Max size (px)**: photos are kept within this many pixels on a side (scaled down, never up). With only a max size and no shape, photos are simply scaled down, with no cropper.
 
-Leave both empty and photos are uploaded as they are. The stored file is the cropped one, so the shape holds everywhere it is shown. A category's picture is always cropped to the `category_image_ratio` setting below. Anything the browser cannot edit (GIF, SVG, HEIC, video) is uploaded untouched. The same two properties (`imageRatio`, `imageMax`) are on the field API, and `<inventory-media-field crop-ratio="1 / 1" crop-max="1600">` applies them in your own forms. Needs kempo-ui 0.5 or newer.
+Leave both empty and photos are uploaded as they are. The stored file is the cropped one, so the shape holds everywhere it is shown. A category's picture is always cropped to the `category_image_ratio` setting below. Anything the browser cannot edit (GIF, SVG, HEIC, video) is uploaded untouched. The same two properties (`imageRatio`, `imageMax`) are on the field API, and `<k-inventory-media-field crop-ratio="1 / 1" crop-max="1600">` applies them in your own forms. Needs kempo-ui 0.5 or newer.
 
 ## Image shape
 
-Two settings (**Admin > Settings**) set the aspect ratio images are *shown* at (a display crop; a photo field's forced shape above changes what is stored): `category_image_ratio` and `item_image_ratio`, written `width:height` (`4:3` by default, or `1:1`, `16:9`...). A blank or invalid value falls back to `4:3`. Images are **cropped to fit** the shape, never stretched, and the originals are not changed, so changing the setting reshapes every image at once. The admin's category and item pickers use them, and `GET /inventory/api/fields` returns them as `imageRatios` (CSS, e.g. `"4 / 3"`) so a site can do the same; `<inventory-media-field ratio-for="category">` previews at the category shape.
+Two settings (**Admin > Settings**) set the aspect ratio images are *shown* at (a display crop; a photo field's forced shape above changes what is stored): `category_image_ratio` and `item_image_ratio`, written `width:height` (`4:3` by default, or `1:1`, `16:9`...). A blank or invalid value falls back to `4:3`. Images are **cropped to fit** the shape, never stretched, and the originals are not changed, so changing the setting reshapes every image at once. The admin's category and item pickers use them, and `GET /inventory/api/fields` returns them as `imageRatios` (CSS, e.g. `"4 / 3"`) so a site can do the same; `<k-inventory-media-field ratio-for="category">` previews at the category shape.
 
 ## Import and export
 
-**Admin > Inventory** has **Export** and **Import** buttons (admin portal only; the public site has none). Both are limited to the **top tier**: the `kempo-inventory:fields:manage` permission, held by the `kempo-inventory:admin` group. A manager, a viewer or a signed-out visitor gets a 403 (or 401) and does not see the buttons, because an export carries the whole inventory out and an import can rewrite and re-stock all of it.
+**Admin > Inventory** has **Export** and **Import** buttons (admin portal only; the public site has none). Both are limited to the **top tier**: the `kempo-inventory:fields:manage` permission, held by the `kempo-inventory:admin` group. A manager, a viewer or a signed-out visitor gets a 403 (or 401) and does not see the buttons, because an export carries the whole inventory out and an import can rewrite and re-quantity all of it.
 
 **Export** downloads the whole inventory in one of two forms:
 
@@ -95,7 +95,7 @@ Two settings (**Admin > Settings**) set the aspect ratio images are *shown* at (
 **Import** takes either one (or any zip with an `inventory.json` in this format, including one re-zipped with compression). It is **done on the server**, in two steps:
 
 1. **Check.** The file is uploaded once and checked. You see how many items are new, how many already exist (matched by **SKU**; categories by name), what would be ignored, and any rows that cannot be imported and why. Nothing in the inventory has changed yet.
-2. **Import.** For the ones that already exist you choose **Ignore them** (leave what is here exactly as it is; the default) or **Update them** with the file's values (a value the file leaves empty never clears anything, and a changed quantity is recorded as a stock adjustment, "import", so the history stays honest).
+2. **Import.** For the ones that already exist you choose **Ignore them** (leave what is here exactly as it is; the default) or **Update them** with the file's values (a value the file leaves empty never clears anything, and a changed quantity is recorded as a quantity adjustment, "import", so the history stays honest).
 
 Things worth knowing: an import never creates or changes **fields**; a value only comes across when a field with the same key exists and applies to the item's category (the rest are ignored and counted). Rows are independent: one that fails (a missing name, a bad number, a required field with no value) does not stop the others. A field linking to another item is exported as that item's SKU and resolved by SKU on import, including to items created in the same import. Photos only come from the zip; each distinct photo is stored once, to the library new uploads normally go to (as the person importing, with its own file-library rules), at its original size.
 
@@ -122,11 +122,11 @@ Items and categories can be **tagged**: short labels such as `acrylic`, `red`, `
 - **Inheritance:** an item does not inherit its category's tags. Searching a category's tag finds the category, and the category is how you reach its items.
 - The admin lists show a Tags column. To reuse the control in your own forms, `ItemFields.js` exports `tagsValue(tags)`, `suggestTags` and `readTags($tags)` for use with `<k-tags .value=${tagsValue(tags)} .getSuggestions=${suggestTags}>`; `readTags` includes text typed but not yet added.
 
-## Who can read, and who can see stock counts
+## Who can read, and who can see quantity counts
 
 Reading the inventory needs the `items:read` permission. Turn on the `public_read` setting (off by default) and **anyone can read it, signed in or not**, so it can be shared as a catalogue. Public reading covers items, categories and fields (and photos, see below); writing always needs the matching permission.
 
-**Stock counts are only for people who manage stock.** A caller without `stock:adjust` or `items:update`, whether signed out, signed in with only `items:read`, or reading publicly, gets items **without `quantity`** and no stock history (`GET /inventory/api/movements` is refused). Callers who do manage stock get everything as before.
+**Quantity counts are only for people who manage quantity.** A caller without `quantity:adjust` or `items:update`, whether signed out, signed in with only `items:read`, or reading publicly, gets items **without `quantity`** and no stock history (`GET /inventory/api/movements` is refused). Callers who do manage quantity get everything as before.
 
 ## Who can see photos
 
@@ -186,12 +186,12 @@ scanner.stop();            // release the camera
 This extension ships the data and the API, plus an admin screen for managing it. A site that wants its own screens (a dashboard, product pages, a storefront) builds them itself, and can reuse the same browser modules the admin page uses:
 
 ```javascript
-import { getItems, getFields, adjustStock } from '/inventory/sdk.js';            // the API client
+import { getItems, getFields, adjustQuantity } from '/inventory/sdk.js';            // the API client
 import { openItemDialog, openAdjustDialog } from '/inventory/components/ItemDialog.js';
 import { fieldTemplate, readField, displayValue } from '/inventory/components/ItemFields.js';
 
 openItemDialog({ item, fields, onSaved: item => reload() });    // the form in a dialog, for a screen that really wants one
-openAdjustDialog({ item, onSaved: item => reload() });          // add or remove stock
+openAdjustDialog({ item, onSaved: item => reload() });          // add or remove quantity
 ```
 
 **Adding and editing an item are pages, not dialogs.** A dialog closes with a stray tap outside it and takes everything entered with it (photos taken with the camera included), so each gets a page of its own that keeps the work and warns before it is left. In the admin they are **Inventory > New Item** (`/admin/extension/kempo-inventory/new`) and the edit action on a row (`/admin/extension/kempo-inventory/edit?id=…`). A site gets the same from `NewItemPage.js`:
@@ -219,7 +219,7 @@ An extension that adds to inventory declares the dependency, registers its field
   "dependencies": ["kempo-inventory"],
   "hooks": {
     "kempo-inventory:item:before_create": "./hooks/before-create.js",
-    "kempo-inventory:stock:adjusted": "./hooks/stock-adjusted.js"
+    "kempo-inventory:quantity:adjusted": "./hooks/quantity-adjusted.js"
   }
 }
 ```
@@ -254,7 +254,7 @@ Fields, categories and items can each belong to an extension. `owner` is `''` fo
 |---|---|---|
 | **Field** | delete it, change its key, type (within the safe conversions), requirement or options | rename it, change its description, list/suggest settings and position |
 | **Category** | rename it (which rewrites its items), merge into or out of it, delete it | change its image, description and tags, and put items in it |
-| **Item** | change its SKU, name and category, delete it | edit description, tags and custom field values, and **adjust stock** |
+| **Item** | change its SKU, name and category, delete it | edit description, tags and custom field values, and **adjust quantity** |
 
 A category cannot be renamed or merged by anyone but its owner while it holds items or fields another extension owns, because that would rewrite them. Sending an owned item's current SKU, name and category back unchanged is not a change, so the admin form keeps working.
 
@@ -295,7 +295,7 @@ To protect more than this (say, the *values* of a field you own), subscribe to t
 ### Server SDK
 
 ```javascript
-import { getItems, createItem, adjustStock, registerFields } from 'kempo-inventory/sdk';
+import { getItems, createItem, adjustQuantity, registerFields } from 'kempo-inventory/sdk';
 ```
 
 Every function resolves to `[error, result]`, where `error` is `{ code, msg }` or `null`.
@@ -308,10 +308,10 @@ Every function resolves to `[error, result]`, where `error` is `{ code, msg }` o
 | `createItem({ sku, name, description, quantity, fields, userId }, { owner })` | Create. `owner` makes it your extension's |
 | `updateItem(id, { sku, name, description, fields, userId }, { owner })` | Update; `fields` is merged, and an empty value clears a field. SKU, name and category of an owned item need its `owner` |
 | `deleteItem(id, { userId, owner })` | Delete an item and its history (owned items need their `owner`) |
-| `adjustStock(id, { delta, reason, note, userId })` | The way quantity changes, for anyone. Atomic; refuses to go below zero |
-| `adjustStockMany(changes, { reason, note, ref, userId, owner })` | Several stock changes together: every one happens or none does. `changes` is `[{ id, delta }]`. Use it when one event touches several items, such as the materials of a recipe |
+| `adjustQuantity(id, { delta, reason, note, userId })` | The way quantity changes, for anyone. Atomic; refuses to go below zero |
+| `adjustQuantityMany(changes, { reason, note, ref, userId, owner })` | Several quantity changes together: every one happens or none does. `changes` is `[{ id, delta }]`. Use it when one event touches several items, such as the materials of a recipe |
 | `unregisterItems(owner, { release })` | Delete every item you own, or with `release` hand them back to people |
-| `getMovements({ itemId, limit, offset })` | Stock history |
+| `getMovements({ itemId, limit, offset })` | Quantity history |
 | `getFields({ category, owner })`, `getField(key, category)` | Read field definitions. `getFields()` is every field (each with its `category` key and `categoryName`); with `category` it is what an item in that category shows |
 | `createField(definition)`, `updateField(key, changes)`, `deleteField(key)` | Manage user-defined fields |
 | `getCategories({ includeEmpty, owner })`, `saveCategory(name, { newName, image, description, tags }, { owner })`, `deleteCategory(name, { owner })` | The categories, and managing them |
@@ -325,19 +325,19 @@ An item looks like `{ id, sku, name, description, category, tags, quantity, fiel
 
 ### Several items at once
 
-`adjustStock` changes one item in its own transaction, so a sale that uses resin, paint and filament could take the resin and then find the paint short. `adjustStockMany` applies the whole set together:
+`adjustQuantity` changes one item in its own transaction, so a sale that uses resin, paint and filament could take the resin and then find the paint short. `adjustQuantityMany` applies the whole set together:
 
 ```javascript
-import { adjustStockMany } from 'kempo-inventory/sdk';
+import { adjustQuantityMany } from 'kempo-inventory/sdk';
 
-const [error, { items }] = await adjustStockMany(
+const [error, { items }] = await adjustQuantityMany(
   [{ id: resin.id, delta: -175 }, { id: paint.id, delta: -20 }],
   { reason: 'sale', ref: 'order-1042', owner: 'my-extension' },
 );
-// error.code 409 and error.msg "Insufficient stock of Paint (ml)": nothing changed
+// error.code 409 and error.msg "Insufficient quantity of Paint (ml)": nothing changed
 ```
 
-Changes to the same item are added together and one that nets to nothing is left out. Every item goes through the same `before_adjust` guard as `adjustStock`, and each fires `stock:adjusted` once everything is committed. `ref` is written on every stock movement (as `[order-1042]` in its note) so the change can be found, and reversed, later.
+Changes to the same item are added together and one that nets to nothing is left out. Every item goes through the same `before_adjust` guard as `adjustQuantity`, and each fires `quantity:adjusted` once everything is committed. `ref` is written on every quantity movement (as `[order-1042]` in its note) so the change can be found, and reversed, later.
 
 ### Adding to the item page
 
@@ -354,7 +354,7 @@ Declare these in your `kempo-config.json` `hooks`. Every payload also carries `a
 | `kempo-inventory:item:before_create` | `{ draft: { sku, name, description, quantity, fields }, userId }` | edit `draft` |
 | `kempo-inventory:item:before_update` | `{ item, changes: { sku?, name?, description?, fields? }, userId }` | edit `changes` |
 | `kempo-inventory:item:before_delete` | `{ item, userId }` | refuse only |
-| `kempo-inventory:stock:before_adjust` | `{ item, draft: { delta, reason, note }, userId }` | edit `draft` |
+| `kempo-inventory:quantity:before_adjust` | `{ item, draft: { delta, reason, note }, userId }` | edit `draft` |
 | `kempo-inventory:category:before_update` | `{ name, newName, changes: { description?, tags?, image? }, userId }` | refuse only |
 | `kempo-inventory:category:before_delete` | `{ category, name, userId }` (`category` is `null` for one with no record) | refuse only |
 | `kempo-inventory:field:before_create` | `{ draft }` | refuse only |
@@ -370,7 +370,7 @@ Ownership is checked first, so these only run for changes that would otherwise g
 | `kempo-inventory:item:created` | `{ item, userId }` |
 | `kempo-inventory:item:updated` | `{ item, previous, userId }` |
 | `kempo-inventory:item:deleted` | `{ item, userId }` |
-| `kempo-inventory:stock:adjusted` | `{ item, previousQuantity, delta, reason, note, movement, userId }` |
+| `kempo-inventory:quantity:adjusted` | `{ item, previousQuantity, delta, reason, note, movement, userId }` |
 | `kempo-inventory:category:updated` | `{ category, previous, moved, userId }` |
 | `kempo-inventory:category:deleted` | `{ category, userId }` |
 | `kempo-inventory:field:created` | `{ field }` |
@@ -380,7 +380,7 @@ Ownership is checked first, so these only run for changes that would otherwise g
 For example, a low-stock check that reacts to every adjustment:
 
 ```javascript
-// hooks/stock-adjusted.js
+// hooks/quantity-adjusted.js
 export default async ({ item }) => {
   const level = item.fields.reorderLevel;
   if(level !== undefined && item.quantity <= level){
@@ -399,7 +399,7 @@ Hooks run one at a time, in registration order, and are awaited, so a slow handl
 | `kempo-inventory:items:create` | Add items |
 | `kempo-inventory:items:update` | Edit items |
 | `kempo-inventory:items:delete` | Delete items (and their history) |
-| `kempo-inventory:stock:adjust` | Add or remove stock |
+| `kempo-inventory:quantity:adjust` | Add or remove quantity |
 | `kempo-inventory:fields:manage` | Create, edit and delete custom fields |
 
 Groups, each including everything in the one before it:
@@ -407,7 +407,7 @@ Groups, each including everything in the one before it:
 | Group | Can |
 |---|---|
 | `kempo-inventory:viewer` | View items, fields and movements |
-| `kempo-inventory:manager` | Also create, edit and delete items and adjust stock |
+| `kempo-inventory:manager` | Also create, edit and delete items and adjust quantity |
 | `kempo-inventory:admin` | Also set up the custom fields (`fields:manage`) |
 
 Every group also includes `system:admin:access`, because kempo serves extension pages inside the admin panel and redirects anyone without it. That only opens the panel itself: its other sections stay locked behind their own permissions.
@@ -449,4 +449,4 @@ The documentation site is written in `docs-src/` and built into `docs/` (served
 
 ## Dashboard widget
 
-Adds a **Inventory** widget to the kempo admin dashboard showing item, unit and out-of-stock counts and the latest stock movements, with a **New item** button. It is declared in `widgets` in `kempo-config.json` and registered when the extension is installed or updated; people only see it if they hold its permission, and can hide, reorder or resize it from the dashboard's Customize dialog. Needs a kempo with the dashboard (see kempo's `docs/dashboard.md`); on an older kempo the entry is ignored.
+Adds a **Inventory** widget to the kempo admin dashboard showing item, unit and out-of-stock counts and the latest quantity movements, with a **New item** button. It is declared in `widgets` in `kempo-config.json` and registered when the extension is installed or updated; people only see it if they hold its permission, and can hide, reorder or resize it from the dashboard's Customize dialog. Needs a kempo with the dashboard (see kempo's `docs/dashboard.md`); on an older kempo the entry is ignored.

package/admin/categories/index.page.html

@@ -63,7 +63,7 @@ locked: true
     const [, permData] = await getAllCurrentUserPermissions();
     const canEdit = new Set(permData?.permissions ?? []).has('kempo-inventory:items:update');
 
-    const manageFields = document.createElement('inventory-row-action');
+    const manageFields = document.createElement('k-inventory-row-action');
     manageFields.setAttribute('slot', 'before');
     manageFields.setAttribute('action', 'fields');
     manageFields.setAttribute('icon', 'settings');
@@ -71,7 +71,7 @@ locked: true
     $table.appendChild(manageFields);
 
     if(canEdit){
-      const edit = document.createElement('inventory-row-action');
+      const edit = document.createElement('k-inventory-row-action');
       edit.setAttribute('slot', 'before');
       edit.setAttribute('action', 'edit');
       edit.setAttribute('icon', 'edit');
@@ -142,7 +142,7 @@ locked: true
           </div>
           <div class="mb">
             <label class="d-b mb-sm">Image</label>
-            <inventory-media-field id="cat-image" ratio-for="category" .max=${1} .value=${category?.image ? [category.image.id] : []} .assets=${category?.image ? { [category.image.id]: category.image } : {}}></inventory-media-field>
+            <k-inventory-media-field id="cat-image" ratio-for="category" .max=${1} .value=${category?.image ? [category.image.id] : []} .assets=${category?.image ? { [category.image.id]: category.image } : {}}></k-inventory-media-field>
           </div>
         </div>
       `, {

package/admin/fields/index.page.html

@@ -63,7 +63,7 @@ locked: true
       for(const [name, value] of Object.entries(attributes)) $control.setAttribute(name, value);
       $table.appendChild($control);
     };
-    addControl('inventory-row-action', 'before', { action: 'edit', icon: 'edit', title: 'Edit' });
+    addControl('k-inventory-row-action', 'before', { action: 'edit', icon: 'edit', title: 'Edit' });
     $table.setAttribute('request-delete', '');
     addControl('kc-tc-delete-record', 'after');
 

package/admin/icons/inventory-categories.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 960 960" xmlns="http://www.w3.org/2000/svg"><path fill="currentColor" d="M228.283,855.577l-156.434,-89.949c-7.077,-4.097 -12.571,-9.498 -16.481,-16.202c-3.911,-6.704 -5.866,-14.154 -5.866,-22.348l0,-177.664c0,-8.194 1.955,-15.643 5.866,-22.348c3.911,-6.704 9.405,-12.105 16.481,-16.202l156.434,-89.949c7.077,-4.097 14.526,-6.146 22.348,-6.146c7.822,0 15.271,2.049 22.348,6.146l156.434,89.949c7.077,4.097 12.571,9.498 16.481,16.202c3.911,6.704 5.866,14.154 5.866,22.348l0,177.664c0,8.194 -1.955,15.643 -5.866,22.348c-3.911,6.704 -9.405,12.105 -16.481,16.202l-156.434,89.949c-7.077,4.097 -14.526,6.146 -22.348,6.146c-7.822,0 -15.271,-2.049 -22.348,-6.146Zm111.738,-294.99l43.019,-24.582l-132.41,-76.541l-43.578,25.141l132.969,75.982Zm-111.738,243.59l0,-153.082l-134.086,-77.658l0,153.082l134.086,77.658Zm44.695,0l134.086,-77.658l0,-153.082l-134.086,77.658l0,153.082Zm-22.348,-191.631l43.578,-25.141l-132.41,-76.541l-43.578,25.141l132.41,76.541Zm391.07,243.031l-156.434,-89.949c-7.077,-4.097 -12.571,-9.498 -16.481,-16.202c-3.911,-6.704 -5.866,-14.154 -5.866,-22.348l0,-177.664c0,-8.194 1.955,-15.643 5.866,-22.348c3.911,-6.704 9.405,-12.105 16.481,-16.202l156.434,-89.949c7.077,-4.097 14.526,-6.146 22.348,-6.146c7.822,0 15.271,2.049 22.348,6.146l156.434,89.949c7.077,4.097 12.571,9.498 16.481,16.202c3.911,6.704 5.866,14.154 5.866,22.348l0,177.664c0,8.194 -1.955,15.643 -5.866,22.348c-3.911,6.704 -9.405,12.105 -16.481,16.202l-156.434,89.949c-7.077,4.097 -14.526,6.146 -22.348,6.146c-7.822,0 -15.271,-2.049 -22.348,-6.146Zm44.695,-51.4l134.086,-77.658l0,-153.082l-134.086,77.658l0,153.082Zm-44.695,0l0,-153.082l-134.086,-77.658l0,153.082l134.086,77.658Zm22.348,-191.631l43.578,-25.141l-132.41,-76.541l-43.578,25.141l132.41,76.541Zm89.391,-51.958l43.019,-24.582l-132.41,-76.541l-43.578,25.141l132.969,75.982Zm-324.027,-55.763l-156.434,-89.949c-7.077,-4.097 -12.571,-9.498 -16.481,-16.202c-3.911,-6.704 -5.866,-14.154 -5.866,-22.348l0,-177.664c0,-8.194 1.955,-15.643 5.866,-22.348c3.911,-6.704 9.405,-12.105 16.481,-16.202l156.434,-89.949c7.077,-4.097 14.526,-6.146 22.348,-6.146c7.822,0 15.271,2.049 22.348,6.146l156.434,89.949c7.077,4.097 12.571,9.498 16.481,16.202c3.911,6.704 5.866,14.154 5.866,22.348l0,177.664c0,8.194 -1.955,15.643 -5.866,22.348c-3.911,6.704 -9.405,12.105 -16.481,16.202l-156.434,89.949c-7.077,4.097 -14.526,6.146 -22.348,6.146c-7.822,0 -15.271,-2.049 -22.348,-6.146Zm111.738,-294.99l43.019,-24.582l-132.866,-77.453l-43.122,26.054l132.969,75.982Zm-111.738,243.59l0,-153.082l-134.086,-77.658l0,153.082l134.086,77.658Zm22.348,-191.631l43.578,-25.141l-132.41,-76.541l-43.578,25.141l132.41,76.541Zm22.348,191.631l134.086,-77.658l0,-153.082l-134.086,77.658l0,153.082Z"/></svg>

package/admin/icons/inventory.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 960 960" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:affinity="https://www.affinity.studio/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><path d="M440,777l0,-274l-240,-139l0,274l240,139Zm80,0l240,-139l0,-274l-240,139l0,274Zm-80,92l-280,-161c-12.667,-7.333 -22.5,-17 -29.5,-29c-7,-12 -10.5,-25.333 -10.5,-40l0,-318c0,-14.667 3.5,-28 10.5,-40c7,-12 16.833,-21.667 29.5,-29l280,-161c12.667,-7.333 26,-11 40,-11c14,0 27.333,3.667 40,11l280,161c12.667,7.333 22.5,17 29.5,29c7,12 10.5,25.333 10.5,40l0,318c0,14.667 -3.5,28 -10.5,40c-7,12 -16.833,21.667 -29.5,29l-280,161c-12.667,7.333 -26,11 -40,11c-14,0 -27.333,-3.667 -40,-11Zm200,-528l77,-44l-237,-137l-78,45l238,136Zm-160,93l78,-45l-237,-137l-78,45l237,137Z" style="fill-rule:nonzero;"/></svg>

package/admin/index.page.html

@@ -40,14 +40,14 @@ locked: true
       <kc-tc-field-sort-hide></kc-tc-field-sort-hide>
       <div class="flex"></div>
       <k-permission has="kempo-inventory:fields:manage">
-        <button id="importBtn" class="btn m0"><k-icon name="arrow" direction="up"></k-icon> Import</button>
+        <button id="importBtn" class="btn m0"><k-icon name="download" rotation="180"></k-icon> Import</button>
       </k-permission>
       <k-permission has="kempo-inventory:fields:manage">
         <button id="exportBtn" class="btn m0"><k-icon name="download"></k-icon> Export</button>
       </k-permission>
       <a href="/admin/extension/kempo-inventory/categories" class="btn"><k-icon name="folder"></k-icon> Categories</a>
       <k-permission has="kempo-inventory:fields:manage">
-        <a href="/admin/extension/kempo-inventory/fields" class="btn"><k-icon name="settings"></k-icon> Fields</a>
+        <a href="/admin/extension/kempo-inventory/fields" class="btn"><k-icon name="fields"></k-icon> Fields</a>
       </k-permission>
       <k-permission has="kempo-inventory:items:create">
         <button id="newItemBtn" class="primary m0"><k-icon name="add"></k-icon> New Item</button>
@@ -91,8 +91,8 @@ locked: true
       for(const [name, value] of Object.entries(attributes)) $control.setAttribute(name, value);
       $table.appendChild($control);
     };
-    if(can('items:update')) addControl('inventory-row-action', 'before', { action: 'edit', icon: 'edit', title: 'Edit' });
-    if(can('stock:adjust')) addControl('inventory-row-action', 'before', { action: 'adjust', icon: 'repeat', title: 'Adjust stock' });
+    if(can('items:update')) addControl('k-inventory-row-action', 'before', { action: 'edit', icon: 'edit', title: 'Edit' });
+    if(can('quantity:adjust')) addControl('k-inventory-row-action', 'before', { action: 'adjust', icon: 'repeat', title: 'Adjust quantity' });
     if(can('items:delete')){
       $table.setAttribute('request-delete', '');
       addControl('kc-tc-delete-record', 'after');
@@ -170,7 +170,7 @@ locked: true
         Toast.error(`"${record.name}" is managed by the ${record.owner} extension and cannot be deleted here`);
         return;
       }
-      Dialog.confirm(`Delete "${record.name}" and its stock history? This action cannot be undone.`, async confirmed => {
+      Dialog.confirm(`Delete "${record.name}" and its quantity history? This action cannot be undone.`, async confirmed => {
         if(!confirmed){ reject(); return; }
         const [error] = await deleteItem(record.id);
         if(error){

package/admin/nav.global.html

@@ -1,3 +1,6 @@
-<content id="kempo-inventory-nav" name="Inventory" owner="kempo-inventory" enabled="true" locked="true" location="admin-nav-extensions" priority="30">
-<k-aside-item icon="archive" group="Commerce" href="/admin/extension/kempo-inventory/" no-expand>Inventory</k-aside-item>
+<content id="kempo-inventory-nav" name="Inventory" owner="kempo-inventory" enabled="true" locked="true" location="admin-nav-extensions" priority="87">
+<k-aside-item icon-src="/admin/extension/kempo-inventory/icons/inventory.svg" group="Products" href="/admin/extension/kempo-inventory/" no-expand>Inventory</k-aside-item>
+</content>
+<content id="kempo-inventory-categories-nav" name="Inventory Categories" owner="kempo-inventory" enabled="true" locked="true" location="admin-nav-extensions" priority="86">
+<k-aside-item icon-src="/admin/extension/kempo-inventory/icons/inventory-categories.svg" group="Products" href="/admin/extension/kempo-inventory/categories/" no-expand>Inventory Categories</k-aside-item>
 </content>

package/kempo-config.json

@@ -5,12 +5,12 @@
   "schema": "./server/db/schema.js",
   "widgets": [
     {
-      "key": "stock",
+      "key": "quantity",
       "title": "Inventory",
-      "description": "Item and unit counts, what is out of stock and the latest stock movements.",
-      "icon": "archive",
-      "element": "k-inv-widget",
-      "module": "/inventory/components/StockWidget.js",
+      "description": "Item and unit counts, what is out of stock and the latest quantity movements.",
+      "iconSrc": "/admin/extension/kempo-inventory/icons/inventory.svg",
+      "element": "k-inventory-widget",
+      "module": "/inventory/components/QuantityWidget.js",
       "defaultWidth": 2,
       "defaultHeight": 2,
       "minWidth": 1,
@@ -22,7 +22,7 @@
   "permissions": [
     {
       "name": "kempo-inventory:items:read",
-      "description": "View inventory items, fields and stock movements"
+      "description": "View inventory items, fields and quantity movements"
     },
     {
       "name": "kempo-inventory:items:create",
@@ -37,8 +37,8 @@
       "description": "Delete inventory items"
     },
     {
-      "name": "kempo-inventory:stock:adjust",
-      "description": "Add or remove stock on inventory items"
+      "name": "kempo-inventory:quantity:adjust",
+      "description": "Add or remove quantity on inventory items"
     },
     {
       "name": "kempo-inventory:fields:manage",
@@ -56,26 +56,26 @@
     },
     {
       "name": "kempo-inventory:manager",
-      "description": "Can view and manage items and stock levels",
+      "description": "Can view and manage items and quantity levels",
       "permissions": [
         "system:admin:access",
         "kempo-inventory:items:read",
         "kempo-inventory:items:create",
         "kempo-inventory:items:update",
         "kempo-inventory:items:delete",
-        "kempo-inventory:stock:adjust"
+        "kempo-inventory:quantity:adjust"
       ]
     },
     {
       "name": "kempo-inventory:admin",
-      "description": "Can manage items and stock levels, and set up the custom fields items have",
+      "description": "Can manage items and quantity levels, and set up the custom fields items have",
       "permissions": [
         "system:admin:access",
         "kempo-inventory:items:read",
         "kempo-inventory:items:create",
         "kempo-inventory:items:update",
         "kempo-inventory:items:delete",
-        "kempo-inventory:stock:adjust",
+        "kempo-inventory:quantity:adjust",
         "kempo-inventory:fields:manage"
       ]
     }
@@ -91,7 +91,7 @@
       "name": "public_read",
       "value": false,
       "type": "boolean",
-      "description": "Let anyone, signed in or not, browse the inventory (items, categories, photos). They never see stock counts. Off by default: reading otherwise needs the items:read permission."
+      "description": "Let anyone, signed in or not, browse the inventory (items, categories, photos). They never see quantity counts. Off by default: reading otherwise needs the items:read permission."
     },
     {
       "name": "public_photos",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kempo-inventory",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "A basic inventory management system for kempo cms",
   "license": "MIT",
   "author": "Dustin Poissant",
@@ -15,8 +15,8 @@
   "type": "module",
   "main": "sdk.js",
   "scripts": {
-    "test": "node scripts/run-tests.js unit node --test",
-    "test:integration": "node scripts/run-tests.js integration node --test",
+    "test": "node scripts/run-tests.js unit node --test --test-concurrency=1",
+    "test:integration": "node scripts/run-tests.js integration node --test --test-concurrency=1",
     "link:local": "npm install ../kempo ../kempo-server ../kempo-ui --no-save --no-legacy-peer-deps --force",
     "docs:build": "node scripts/build-docs.js",
     "docs:dev": "npx kempo-server --root docs --port 4050"
@@ -39,8 +39,8 @@
     "drizzle-orm": "^0.45.2"
   },
   "peerDependencies": {
-    "kempo": ">=4.5.8",
-    "kempo-ui": ">=0.5.0",
+    "kempo": ">=4.7.0",
+    "kempo-ui": ">=0.6.0",
     "kempo-media": ">=0.3.0",
     "kempo-files": ">=0.1.3",
     "kempo-thumbs": ">=0.1.3"

package/public/api/items/[id]/GET.js

@@ -7,8 +7,8 @@ export default async (request, response) => {
 
   const [error, item] = await getItem(request.params.id);
   if(error) return response.status(error.code).json({ error: error.msg });
-  /* The stock history is all counts, so it is only for people who manage stock. */
-  const [, movements] = access.canSeeStock ? await getMovements({ itemId: item.id, limit: 100 }) : [null, []];
+  /* The quantity history is all counts, so it is only for people who manage quantity. */
+  const [, movements] = access.canSeeQuantity ? await getMovements({ itemId: item.id, limit: 100 }) : [null, []];
   const [, linked] = await getLinked(item);
   const [, media] = await getMedia(item);
   response.json({ item: forCaller(item, access), movements: movements || [], linked: linked || {}, media: media || {} });

package/public/api/items/[id]/adjust/POST.js

@@ -1,12 +1,12 @@
 import authorize from '../../../../../server/utils/authorize.js';
-import { adjustStock } from '../../../../../server/utils/items.js';
+import { adjustQuantity } from '../../../../../server/utils/items.js';
 
 export default async (request, response) => {
-  const [authError, auth] = await authorize(request, 'stock:adjust');
+  const [authError, auth] = await authorize(request, 'quantity:adjust');
   if(authError) return response.status(authError.code).json({ error: authError.msg });
 
   const { delta, reason, note } = request.body || {};
-  const [error, item] = await adjustStock(request.params.id, { delta, reason, note, userId: auth.userId });
+  const [error, item] = await adjustQuantity(request.params.id, { delta, reason, note, userId: auth.userId });
   if(error) return response.status(error.code).json({ error: error.msg });
   response.json({ item });
 };

package/public/api/movements/GET.js

@@ -4,7 +4,7 @@ import { getMovements } from '../../../server/utils/items.js';
 export default async (request, response) => {
   const [authError, access] = await authorizeRead(request);
   if(authError) return response.status(authError.code).json({ error: authError.msg });
-  if(!access.canSeeStock) return response.status(403).json({ error: 'Insufficient permissions' });
+  if(!access.canSeeQuantity) return response.status(403).json({ error: 'Insufficient permissions' });
 
   const { itemId, limit, offset } = request.query;
   const [error, movements] = await getMovements({

package/public/components/ImportExport.js

@@ -118,7 +118,7 @@ export const openImportDialog = ({ onDone = () => {} } = {}) => {
           </label>
           <label class="d-f mb" style="gap: var(--spacer_h); align-items: flex-start; cursor: pointer;">
             <input type="radio" name="onMatch" value="update" ?checked=${state.onMatch === 'update'} @change=${() => { state.onMatch = 'update'; draw(); }}>
-            <span><strong>Update them</strong> with the values in the file<br><small class="tc-muted">A value the file leaves empty never clears anything. A changed quantity is recorded as a stock adjustment.</small></span>
+            <span><strong>Update them</strong> with the values in the file<br><small class="tc-muted">A value the file leaves empty never clears anything. A changed quantity is recorded as a quantity adjustment.</small></span>
           </label>` : ''}
         ${problemList(preview.results)}` : ''}
       ${state.phase === 'importing' ? html`<p><k-spinner size="sm"></k-spinner> Importing. With photos this can take a while; keep this window open.</p>` : ''}

package/public/components/ItemDialog.js

@@ -2,7 +2,7 @@ import { html } from '/kempo-ui/lit-all.min.js';
 import Toast from '/kempo-ui/components/Toast.js';
 import Dialog from '/kempo-ui/components/Dialog.js';
 import '/kempo-ui/components/Table.js';
-import { getItem, adjustStock } from '/inventory/sdk.js';
+import { getItem, adjustQuantity } from '/inventory/sdk.js';
 import { createItemForm } from '/inventory/components/ItemForm.js';
 
 /*
@@ -17,7 +17,7 @@ import { createItemForm } from '/inventory/components/ItemForm.js';
     openItemDialog({ fields, defaults: { fields: { brand: 'Vallejo' } }, onSaved: ... });   // custom fields filled in
     openItemDialog({ item, fields, onSaved: item => reload() });           // edit an item
     openItemDialog({ fields, askQuantity: false, defaults: { quantity: 1 }, onSaved });   // no quantity box: the item just exists
-    openAdjustDialog({ item, onSaved: item => reload() });                 // add or remove stock
+    openAdjustDialog({ item, onSaved: item => reload() });                 // add or remove quantity
 
   `fields` is the full field list from getFields(). The form shows the default fields plus those of the
   item's category, and swaps them as the Category box changes. `onSaved` runs after the change is stored.
@@ -71,7 +71,7 @@ export const openAdjustDialog = async ({ item, onSaved = () => {} } = {}) => {
     <div class="p" style=${SCROLL}>
       <p class="mb">Current quantity: <strong>${data.item.quantity}</strong></p>
       <div class="mb">
-        <label class="d-b mb-sm" for="dlg-delta">Change (negative removes stock)</label>
+        <label class="d-b mb-sm" for="dlg-delta">Change (negative removes quantity)</label>
         <input type="number" id="dlg-delta" class="full" step="1" required>
       </div>
       <div class="mb">
@@ -92,7 +92,7 @@ export const openAdjustDialog = async ({ item, onSaved = () => {} } = {}) => {
       <k-table id="historyTable" placeholder="No movements yet."></k-table>
     </div>
   `, {
-    title: `Adjust stock: ${data.item.name}`,
+    title: `Adjust quantity: ${data.item.name}`,
     confirmText: 'Apply',
     cancelText: 'Close',
     confirmAction: async event => {
@@ -102,17 +102,17 @@ export const openAdjustDialog = async ({ item, onSaved = () => {} } = {}) => {
         Toast.error('Enter a non-zero whole number');
         return;
       }
-      const [adjustError, adjusted] = await adjustStock(item.id, {
+      const [adjustError, adjusted] = await adjustQuantity(item.id, {
         delta,
         reason: $dialog.querySelector('#dlg-reason').value,
         note: $dialog.querySelector('#dlg-note').value,
       });
       if(adjustError){
-        Toast.error(adjustError.msg || 'Failed to adjust stock');
+        Toast.error(adjustError.msg || 'Failed to adjust quantity');
         return;
       }
       $dialog.close();
-      Toast.success('Stock updated');
+      Toast.success('Quantity updated');
       onSaved(adjusted.item);
     },
   });

package/public/components/ItemFields.js

@@ -201,7 +201,7 @@ export class InventoryMediaField extends LitElement {
   }
 }
 
-if(!customElements.get('inventory-media-field')) customElements.define('inventory-media-field', InventoryMediaField);
+if(!customElements.get('k-inventory-media-field')) customElements.define('k-inventory-media-field', InventoryMediaField);
 
 /*
   A colour field's control. Colour is optional, so with nothing chosen it offers a button, because a
@@ -312,7 +312,7 @@ class InventoryColorField extends LitElement {
   }
 }
 
-if(!customElements.get('inventory-color-field')) customElements.define('inventory-color-field', InventoryColorField);
+if(!customElements.get('k-inventory-color-field')) customElements.define('k-inventory-color-field', InventoryColorField);
 
 const searchItems = async (event, ownId) => {
   const $combobox = event.currentTarget;
@@ -361,7 +361,7 @@ export const fieldTemplate = (field, value, { linked = {}, media = {}, ownId = n
       control = html`<input type="date" id=${id} class="full" .value=${value ?? ''}>`;
       break;
     case 'color':
-      control = html`<inventory-color-field id=${id} .value=${value ?? ''}></inventory-color-field>`;
+      control = html`<k-inventory-color-field id=${id} .value=${value ?? ''}></k-inventory-color-field>`;
       break;
     case 'rating':
       control = html`<div class="d-f" style="align-items: center; gap: var(--spacer_h);">
@@ -385,7 +385,7 @@ export const fieldTemplate = (field, value, { linked = {}, media = {}, ownId = n
         @select=${e => { e.currentTarget.dataset.itemId = e.detail.value; e.currentTarget.dataset.label = e.detail.label; }}></k-combobox>`;
       break;
     case 'media':
-      control = html`<inventory-media-field id=${id} .value=${value ?? []} .assets=${media} .cropRatio=${field.imageRatio ?? ''} .cropMax=${field.imageMax ?? 0}></inventory-media-field>`;
+      control = html`<k-inventory-media-field id=${id} .value=${value ?? []} .assets=${media} .cropRatio=${field.imageRatio ?? ''} .cropMax=${field.imageMax ?? 0}></k-inventory-media-field>`;
       break;
     default:
       control = field.type === 'text' && field.suggest

package/public/components/ItemForm.js

@@ -93,7 +93,7 @@ export const createItemForm = ({ item = null, fields = [], defaults = {}, askQua
   };
 
   render(html`
-    ${locked ? html`<p class="mb tc-muted">Managed by the ${item.owner} extension. Its SKU, name and category can only be changed there; everything else, including stock, you can edit here.</p>` : ''}
+    ${locked ? html`<p class="mb tc-muted">Managed by the ${item.owner} extension. Its SKU, name and category can only be changed there; everything else, including quantity, you can edit here.</p>` : ''}
     <div class="d-f mb" style="gap: var(--spacer);">
       <div class="flex">
         <label class="d-b mb-sm" for="dlg-sku">SKU *</label>

package/public/components/{StockWidget.js → QuantityWidget.js}

@@ -4,10 +4,10 @@ import { getItems, getMovements } from '/inventory/sdk.js';
 const stat = (value, label, classes = '') => html`<div class="flex"><div class="h2 m0 ${classes}">${value}</div><div class="small tc-muted">${label}</div></div>`;
 
 /*
-  Stock at a glance. Unit and out-of-stock figures are shown only when the page fetched holds every
+  Quantity at a glance. Unit and out-of-stock figures are shown only when the page fetched holds every
   item, so they are never an under-count.
 */
-export default class StockWidget extends DashboardWidget {
+export default class QuantityWidget extends DashboardWidget {
   static properties = {
     ...DashboardWidget.properties,
     total: { state: true },
@@ -68,4 +68,4 @@ export default class StockWidget extends DashboardWidget {
   }
 }
 
-customElements.define('k-inv-widget', StockWidget);
+customElements.define('k-inventory-widget', QuantityWidget);

package/public/components/RowAction.js

@@ -7,7 +7,7 @@ import '/kempo-ui/components/Icon.js';
   The page owns the dialog and the request; this only reports the choice, as an `itemAction`
   event on the table: { action, record }.
 
-    <inventory-row-action action="edit" icon="edit" title="Edit"></inventory-row-action>
+    <k-inventory-row-action action="edit" icon="edit" title="Edit"></k-inventory-row-action>
 */
 export default class RowAction extends AdminTableControl {
   static properties = {
@@ -31,4 +31,4 @@ export default class RowAction extends AdminTableControl {
   render(){ return html`<slot><k-icon name="${this.icon}"></k-icon></slot>`; }
 }
 
-customElements.define('inventory-row-action', RowAction);
+customElements.define('k-inventory-row-action', RowAction);

package/public/sdk.js

@@ -32,7 +32,7 @@ export const getItem = id => req('GET', `${BASE}/items/${enc(id)}`);
 export const createItem = data => req('POST', `${BASE}/items`, data);
 export const updateItem = (id, data) => req('PATCH', `${BASE}/items/${enc(id)}`, data);
 export const deleteItem = id => req('DELETE', `${BASE}/items/${enc(id)}`);
-export const adjustStock = (id, data) => req('POST', `${BASE}/items/${enc(id)}/adjust`, data);
+export const adjustQuantity = (id, data) => req('POST', `${BASE}/items/${enc(id)}/adjust`, data);
 export const getMovements = (params = {}) => req('GET', `${BASE}/movements${buildQuery(params)}`);
 
 /*

package/sdk.js

@@ -13,7 +13,7 @@
     };
 
   Fields, categories and items can all be owned. Pass your extension name as `owner` and only you can
-  delete them or change the parts that define them; people keep editing everything else (stock
+  delete them or change the parts that define them; people keep editing everything else (quantity
   included) in the admin. Owner is never read from an HTTP request, only from these server calls:
 
     registerCategory(owner, { name, description })       registerField(owner, { ..., category })
@@ -31,11 +31,12 @@ export {
   updateItem,
   deleteItem,
   unregisterItems,
-  adjustStock,
-  adjustStockMany,
+  adjustQuantity,
+  adjustQuantityMany,
   getMovements,
 } from './server/utils/items.js';
 
+
 export {
   getFields,
   getField,

package/server/utils/access.js

@@ -2,14 +2,14 @@ import { currentUserHasPermission, getSession, getSetting } from 'kempo/server/s
 import authorize from './authorize.js';
 
 /*
-  Who may read the inventory, and whether they may see stock counts.
+  Who may read the inventory, and whether they may see quantity counts.
 
   Normally reading needs the `items:read` permission. With the `public_read` setting on, anyone can
-  read, signed in or not, so the inventory can be shared as a catalogue. Either way, **stock counts
-  are only for people who manage stock**: callers without `stock:adjust` or `items:update` get items
+  read, signed in or not, so the inventory can be shared as a catalogue. Either way, **quantity counts
+  are only for people who manage quantity**: callers without `quantity:adjust` or `items:update` get items
   with no `quantity` and no stock history.
 
-  Resolves to [null, { userId, canSeeStock, anonymous }] or [{ code, msg }, null].
+  Resolves to [null, { userId, canSeeQuantity, anonymous }] or [{ code, msg }, null].
 */
 export const publicReadEnabled = async () => {
   const [, value] = await getSetting('kempo-inventory', 'public_read', false);
@@ -25,19 +25,19 @@ export const authorizeRead = async request => {
   const token = request.cookies?.session_token;
   const [error, auth] = await authorize(request, 'items:read');
   if(!error){
-    const canSeeStock = (await holds(token, 'stock:adjust')) || (await holds(token, 'items:update'));
-    return [null, { userId: auth.userId, canSeeStock, anonymous: false }];
+    const canSeeQuantity = (await holds(token, 'quantity:adjust')) || (await holds(token, 'items:update'));
+    return [null, { userId: auth.userId, canSeeQuantity, anonymous: false }];
   }
   if(await publicReadEnabled()){
     const [sessionError, session] = token ? await getSession({ token }) : [true, null];
-    return [null, { userId: !sessionError && session?.user ? session.user.id : null, canSeeStock: false, anonymous: true }];
+    return [null, { userId: !sessionError && session?.user ? session.user.id : null, canSeeQuantity: false, anonymous: true }];
   }
   return [error, null];
 };
 
-/* An item as the caller may see it: no stock count unless they manage stock. */
+/* An item as the caller may see it: no stock count unless they manage quantity. */
 export const forCaller = (item, access) => {
-  if(access.canSeeStock) return item;
+  if(access.canSeeQuantity) return item;
   const { quantity, ...rest } = item;
   return rest;
 };

package/server/utils/events.js

@@ -16,8 +16,8 @@ export const EVENTS = {
   itemUpdated: 'kempo-inventory:item:updated',
   itemBeforeDelete: 'kempo-inventory:item:before_delete',
   itemDeleted: 'kempo-inventory:item:deleted',
-  stockBeforeAdjust: 'kempo-inventory:stock:before_adjust',
-  stockAdjusted: 'kempo-inventory:stock:adjusted',
+  quantityBeforeAdjust: 'kempo-inventory:quantity:before_adjust',
+  quantityAdjusted: 'kempo-inventory:quantity:adjusted',
   categoryBeforeUpdate: 'kempo-inventory:category:before_update',
   categoryUpdated: 'kempo-inventory:category:updated',
   categoryBeforeDelete: 'kempo-inventory:category:before_delete',

package/server/utils/importExport.js

@@ -2,7 +2,7 @@ import db from 'kempo/server/db/index.js';
 import { asc } from 'drizzle-orm';
 import { kempoInventoryItem, kempoInventoryCategory } from '../db/schema.js';
 import { getFields } from './fields.js';
-import { getItemBySku, createItem, updateItem, adjustStock } from './items.js';
+import { getItemBySku, createItem, updateItem, adjustQuantity } from './items.js';
 import { getCategories, saveCategory } from './categories.js';
 import { applicableFields, coerceValues } from './fieldTypes.js';
 import { normalizeTags } from './tags.js';
@@ -111,13 +111,13 @@ const given = value => value !== undefined && value !== null && value !== '' &&
 
     onMatch  'skip'    an item or category that already exists (same SKU / same name) is left alone
              'update'  it is updated with the values the file provides; a value the file leaves empty
-                       is never cleared. A changed quantity is applied as a stock adjustment, so the
+                       is never cleared. A changed quantity is applied as a quantity adjustment, so the
                        history shows it.
 
   Rows are independent: one that fails does not stop the others. Resolves to
   [null, { results, categoryResults, summary }].
 */
-export const importData = async ({ items = [], categories = [], onMatch = 'skip', dryRun = false } = {}, { userId = '', canUpdate = false, canAdjustStock = false, maxRows = MAX_IMPORT_ROWS } = {}) => {
+export const importData = async ({ items = [], categories = [], onMatch = 'skip', dryRun = false } = {}, { userId = '', canUpdate = false, canAdjustQuantity = false, maxRows = MAX_IMPORT_ROWS } = {}) => {
   if(!['skip', 'update'].includes(onMatch)) return [{ code: 400, msg: 'onMatch must be "skip" or "update"' }, null];
   if(!Array.isArray(items) || !Array.isArray(categories)) return [{ code: 400, msg: 'items and categories must be lists' }, null];
   if(items.length > maxRows || categories.length > maxRows) return [{ code: 413, msg: `Send at most ${maxRows} rows at a time` }, null];
@@ -199,7 +199,7 @@ export const importData = async ({ items = [], categories = [], onMatch = 'skip'
     if(invalid){ fail(result, invalid.msg); continue; }
 
     if(existing){
-      if(quantity !== undefined && quantity !== existing.quantity && !canAdjustStock){ fail(result, 'Changing a quantity needs the stock:adjust permission'); continue; }
+      if(quantity !== undefined && quantity !== existing.quantity && !canAdjustQuantity){ fail(result, 'Changing a quantity needs the quantity:adjust permission'); continue; }
       result.action = 'update';
       if(dryRun){ summary.updated++; continue; }
       const changes = { fields: coerced };
@@ -210,7 +210,7 @@ export const importData = async ({ items = [], categories = [], onMatch = 'skip'
       const [error] = await updateItem(existing.id, { ...changes, userId });
       if(error && !(error.code === 400 && error.msg === 'No changes provided')){ fail(result, error.msg); continue; }
       if(quantity !== undefined && quantity !== existing.quantity){
-        const [adjustError] = await adjustStock(existing.id, { delta: quantity - existing.quantity, reason: 'import', note: 'Imported', userId });
+        const [adjustError] = await adjustQuantity(existing.id, { delta: quantity - existing.quantity, reason: 'import', note: 'Imported', userId });
         if(adjustError){ fail(result, adjustError.msg); continue; }
       }
       summary.updated++;

package/server/utils/importFile.js

@@ -73,7 +73,7 @@ const mediaIn = ({ items, categories }) => {
   return paths;
 };
 
-const PERMISSIONS = { canUpdate: true, canAdjustStock: true, maxRows: MAX_ITEMS };   // the caller is the top tier, which holds all of these
+const PERMISSIONS = { canUpdate: true, canAdjustQuantity: true, maxRows: MAX_ITEMS };   // the caller is the top tier, which holds all of these
 
 /* What importing this file would do, changing nothing: { results, categoryResults, summary, media }. */
 export const previewImport = async (bytes, { userId }) => {

package/server/utils/items.js

@@ -229,7 +229,7 @@ export const createItem = async ({ sku, name, description = '', category = '', t
       if(qty > 0){
         await tx.insert(kempoInventoryMovement).values({
           id: newId(), itemId: created.id, delta: qty, quantityAfter: qty,
-          reason: 'initial', note: 'Initial stock', userId, created: now,
+          reason: 'initial', note: 'Initial quantity', userId, created: now,
         });
       }
       return created;
@@ -245,7 +245,7 @@ export const createItem = async ({ sku, name, description = '', category = '', t
 
 /*
   Updates sku, name, description and custom field values. Quantity is not editable here: it only
-  changes through adjustStock, which keeps the movement history honest.
+  changes through adjustQuantity, which keeps the movement history honest.
 */
 export const updateItem = async (id, { sku, name, description, category, tags, fields: values, userId = '' } = {}, { owner = '' } = {}) => {
   const [lookupError, existing] = await getItem(id);
@@ -339,13 +339,13 @@ export const deleteItem = async (id, { userId = '', owner = '' } = {}) => {
   Atomic: the quantity changes in a single UPDATE guarded against going negative,
   so concurrent adjustments cannot oversell.
 */
-/* Anyone may adjust stock, owned item or not; `owner` only tells hooks which extension did it. */
-export const adjustStock = async (id, { delta, reason = 'adjustment', note = '', userId = '', owner = '' } = {}) => {
+/* Anyone may adjust quantity, owned item or not; `owner` only tells hooks which extension did it. */
+export const adjustQuantity = async (id, { delta, reason = 'adjustment', note = '', userId = '', owner = '' } = {}) => {
   const [lookupError, existing] = await getItem(id);
   if(lookupError) return [lookupError, null];
 
   const draft = { delta, reason, note };
-  const refused = await guard(EVENTS.stockBeforeAdjust, { item: existing, draft, userId, actor: owner });
+  const refused = await guard(EVENTS.quantityBeforeAdjust, { item: existing, draft, userId, actor: owner });
   if(refused) return [refused, null];
 
   const change = toInt(draft.delta, NaN);
@@ -364,16 +364,16 @@ export const adjustStock = async (id, { delta, reason = 'adjustment', note = '',
       }).returning();
       return { row, movement };
     });
-    if(!result) return [{ code: 409, msg: 'Insufficient stock' }, null];
+    if(!result) return [{ code: 409, msg: 'Insufficient quantity' }, null];
 
     const item = shape(result.row);
-    await notify(EVENTS.stockAdjusted, {
+    await notify(EVENTS.quantityAdjusted, {
       item, previousQuantity: item.quantity - change, delta: change,
       reason: result.movement.reason, note: result.movement.note, movement: result.movement, userId, actor: owner,
     });
     return [null, item];
   } catch {
-    return [{ code: 500, msg: 'Failed to adjust stock' }, null];
+    return [{ code: 500, msg: 'Failed to adjust quantity' }, null];
   }
 };
 
@@ -387,23 +387,23 @@ class Refusal {
 }
 
 /*
-  Applies several stock changes together: every one happens or none does. This is what makes
-  taking the materials for a whole recipe safe, where one adjustStock per item could take the resin
+  Applies several quantity changes together: every one happens or none does. This is what makes
+  taking the materials for a whole recipe safe, where one adjustQuantity per item could take the resin
   and then fail on the paint. `changes` is [{ id, delta, reason?, note? }]; changes to the same item
   are added together, and one that nets to nothing is left out. Each item runs through the same
-  before_adjust guard as adjustStock, and fires the same stock:adjusted notification once everything
+  before_adjust guard as adjustQuantity, and fires the same quantity:adjusted notification once everything
   is committed.
 
-    const [error, result] = await adjustStockMany(
+    const [error, result] = await adjustQuantityMany(
       [{ id: resin.id, delta: -175 }, { id: paint.id, delta: -20 }],
       { reason: 'sale', ref: 'order-1042', owner: 'my-extension' },
     );
 
   `ref` is recorded on every movement so the change can be found and reversed later. A refusal for
-  lack of stock is a 409 that names the item, and nothing has changed. Resolves to
+  lack of quantity is a 409 that names the item, and nothing has changed. Resolves to
   [null, { items }] with the items as they are now.
 */
-export const adjustStockMany = async (changes, { reason = 'adjustment', note = '', ref = '', userId = '', owner = '' } = {}) => {
+export const adjustQuantityMany = async (changes, { reason = 'adjustment', note = '', ref = '', userId = '', owner = '' } = {}) => {
   if(!Array.isArray(changes) || !changes.length) return [{ code: 400, msg: 'changes must be a non-empty list' }, null];
 
   const totals = new Map();
@@ -424,7 +424,7 @@ export const adjustStockMany = async (changes, { reason = 'adjustment', note = '
   try {
     rows = await db.select().from(kempoInventoryItem).where(inArray(kempoInventoryItem.id, wanted.map(entry => entry.id)));
   } catch {
-    return [{ code: 500, msg: 'Failed to adjust stock' }, null];
+    return [{ code: 500, msg: 'Failed to adjust quantity' }, null];
   }
   const existing = new Map(rows.map(row => [row.id, shape(row)]));
   const missing = wanted.find(entry => !existing.has(entry.id));
@@ -433,7 +433,7 @@ export const adjustStockMany = async (changes, { reason = 'adjustment', note = '
   const drafts = new Map();
   for(const entry of wanted){
     const draft = { delta: entry.delta, reason: entry.reason ?? reason, note: entry.note ?? note };
-    const refused = await guard(EVENTS.stockBeforeAdjust, { item: existing.get(entry.id), draft, userId, actor: owner });
+    const refused = await guard(EVENTS.quantityBeforeAdjust, { item: existing.get(entry.id), draft, userId, actor: owner });
     if(refused) return [refused, null];
     const delta = toInt(draft.delta, NaN);
     if(Number.isNaN(delta) || delta === 0) return [{ code: 400, msg: 'delta must be a non-zero whole number' }, null];
@@ -449,7 +449,7 @@ export const adjustStockMany = async (changes, { reason = 'adjustment', note = '
           .set({ quantity: sql`${kempoInventoryItem.quantity} + ${delta}`, updated: new Date() })
           .where(and(eq(kempoInventoryItem.id, entry.id), sql`${kempoInventoryItem.quantity} + ${delta} >= 0`))
           .returning();
-        if(!row) throw new Refusal({ code: 409, msg: `Insufficient stock of ${existing.get(entry.id).name}` });
+        if(!row) throw new Refusal({ code: 409, msg: `Insufficient quantity of ${existing.get(entry.id).name}` });
         const [movement] = await tx.insert(kempoInventoryMovement).values({
           id: newId(), itemId: entry.id, delta, quantityAfter: row.quantity, reason: why,
           note: ref ? `${text ? `${text} ` : ''}[${ref}]` : text, userId, created: new Date(),
@@ -462,14 +462,14 @@ export const adjustStockMany = async (changes, { reason = 'adjustment', note = '
     for(const { row, movement, delta } of applied){
       const item = shape(row);
       items.push(item);
-      await notify(EVENTS.stockAdjusted, {
+      await notify(EVENTS.quantityAdjusted, {
         item, previousQuantity: item.quantity - delta, delta, reason: movement.reason, note: movement.note, movement, userId, actor: owner,
       });
     }
     return [null, { items }];
   } catch(error) {
     if(error instanceof Refusal) return [error.error, null];
-    return [{ code: 500, msg: 'Failed to adjust stock' }, null];
+    return [{ code: 500, msg: 'Failed to adjust quantity' }, null];
   }
 };
 
@@ -487,7 +487,7 @@ export const getMovements = async ({ itemId, limit = 50, offset = 0 } = {}) => {
 /*
   For an extension's uninstall.js: deletes every item it owns, with their history. With `release`
   the items are kept and handed back to the people who manage the inventory instead, which is the
-  right choice when they hold real stock.
+  right choice when they hold real quantity.
 */
 export const unregisterItems = async (owner, { release = false } = {}) => {
   if(!owner) return [{ code: 400, msg: 'An owner (your extension name) is required' }, null];

package/server/utils/ownership.js

@@ -5,7 +5,7 @@ import { tidyCategory } from './categoryLogic.js';
   extension that created it, and `actor` is whoever is making the change in the same terms: the
   HTTP layer never names an actor ('' = a person), only an extension calling the server SDK can.
 
-  Ownership never changes what stock does: anyone with the permission can still adjust an owned
+  Ownership never changes what quantity does: anyone with the permission can still adjust an owned
   item's quantity. It protects what the owner builds on:
 
     items       sku, name, category and deletion belong to the owner

package/update.js

@@ -8,6 +8,14 @@ import { getSetting, setSetting, deleteSetting } from 'kempo/server/sdk.js';
   this on a database that already has the change is harmless.
 */
 export default async () => {
+  // Stock became quantity everywhere. The permission to change it was kempo-inventory:stock:adjust: move every grant to the new name, so nobody loses the right.
+  const OLD = 'kempo-inventory:stock:adjust';
+  const NEW = 'kempo-inventory:quantity:adjust';
+  await db.execute(sql`INSERT INTO "permission" ("name", "description", "owner", "createdAt") SELECT ${NEW}, "description", "owner", "createdAt" FROM "permission" WHERE "name" = ${OLD} ON CONFLICT DO NOTHING`);
+  await db.execute(sql`UPDATE "groupPermission" SET "permissionName" = ${NEW} WHERE "permissionName" = ${OLD} AND NOT EXISTS (SELECT 1 FROM "groupPermission" other WHERE other."groupName" = "groupPermission"."groupName" AND other."permissionName" = ${NEW})`);
+  await db.execute(sql`DELETE FROM "groupPermission" WHERE "permissionName" = ${OLD}`);
+  await db.execute(sql`DELETE FROM "permission" WHERE "name" = ${OLD}`);
+
   // Next: media_provider is retired. kempo-media sits on kempo-files, so new uploads go through it whenever it is installed.
   await deleteSetting('kempo-inventory', 'media_provider');
 
@@ -54,7 +62,7 @@ export default async () => {
 
   // 0.9: optional public (signed-out) browsing. Added only when missing, and off.
   const [, publicRead] = await getSetting('kempo-inventory', 'public_read', null);
-  if(publicRead === null) await setSetting('kempo-inventory', 'public_read', false, 'boolean', false, 'Let anyone, signed in or not, browse the inventory (items, categories, photos). They never see stock counts. Off by default: reading otherwise needs the items:read permission.');
+  if(publicRead === null) await setSetting('kempo-inventory', 'public_read', false, 'boolean', false, 'Let anyone, signed in or not, browse the inventory (items, categories, photos). They never see quantity counts. Off by default: reading otherwise needs the items:read permission.');
 
   // 0.8: photos are public by default, so read-only users can see them. Added only when missing.
   const [, publicSetting] = await getSetting('kempo-inventory', 'public_photos', null);