@kernhq/module-inventory 0.2.0 → 0.3.0

package/dist/contract/notifications.js

@@ -0,0 +1,72 @@
+/**
+ * What Inventory will interrupt somebody about.
+ *
+ * Four things, and each of them changes what somebody has to *do*. That is the test: a rename, a new
+ * category, an item coming back — those are facts a screen shows when somebody looks, and a
+ * notification type nobody wants is a notification type everybody switches off along with the one
+ * that mattered.
+ *
+ * A type declared here and never sent is the same lie as a permission nothing checks. Each of these
+ * names its sender, and every one of them exists:
+ *
+ * - `custody.assigned` — `CustodyService`, on `assign` and `transfer`.
+ * - `warranty.expiring` — the `warranty-sweep` job, once per asset.
+ * - `repair.overdue` — the `repair-overdue` job, once per repair.
+ * - `custody.return_due` — the offboarding subscription, when HR says somebody has left or core says
+ *   they have been removed from the workspace.
+ *
+ * The keys keep their `inventory.custody.*` spelling rather than being renamed to
+ * `inventory.asset.*`: a notification type is the key a person's own preferences are stored under,
+ * so renaming one silently resets everybody who had switched it off.
+ */
+export const inventoryNotificationTypes = [
+    {
+        /**
+         * Everybody who has ever found a laptop on their desk with no idea it was now theirs is the
+         * reason this is `urgent` and reaches email — an asset register that records a handover the
+         * recipient never learns about has recorded an argument for later.
+         */
+        type: 'inventory.custody.assigned',
+        label: 'An item was handed to you',
+        description: 'Somebody made you the holder of an asset in the register.',
+        defaults: { inapp: true, push: true, email: true },
+        urgent: true,
+    },
+    {
+        /**
+         * Not urgent, and email is off by default. A warranty running out in a month is a thing to plan
+         * for, not a thing to stop for — and it arrives on a schedule rather than because somebody did
+         * something, which is exactly the kind of message that trains people to ignore the rest.
+         */
+        type: 'inventory.warranty.expiring',
+        label: 'A warranty is about to run out',
+        description: "An item's warranty expires soon. Sent once per item, to whoever is holding it.",
+        defaults: { inapp: true, push: false, email: false },
+        urgent: false,
+    },
+    {
+        /**
+         * Push, because this one is an action somebody has to take — ring the repairer — and nobody
+         * goes looking for it. Still not urgent: a laptop that has been away a fortnight can wait until
+         * the phone is picked up.
+         */
+        type: 'inventory.repair.overdue',
+        label: 'A repair has been away too long',
+        description: 'An item sent for repair has not been logged as returned. Sent once per repair.',
+        defaults: { inapp: true, push: true, email: false },
+        urgent: false,
+    },
+    {
+        /**
+         * Somebody is leaving and still has company property. Email, because it is a list of things to
+         * collect from a person who may not be at their desk much longer, and an in-app badge nobody
+         * opens until Monday is how a laptop leaves the building.
+         */
+        type: 'inventory.custody.return_due',
+        label: 'Somebody leaving still holds company property',
+        description: 'A member has left, or is leaving, and items are still recorded as theirs.',
+        defaults: { inapp: true, push: true, email: true },
+        urgent: true,
+    },
+];
+//# sourceMappingURL=notifications.js.map

package/dist/contract/notifications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notifications.js","sourceRoot":"","sources":["../../src/contract/notifications.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAA+B;IACpE;QACE;;;;WAIG;QACH,IAAI,EAAE,4BAA4B;QAClC,KAAK,EAAE,2BAA2B;QAClC,WAAW,EAAE,2DAA2D;QACxE,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;QAClD,MAAM,EAAE,IAAI;KACb;IACD;QACE;;;;WAIG;QACH,IAAI,EAAE,6BAA6B;QACnC,KAAK,EAAE,gCAAgC;QACvC,WAAW,EAAE,gFAAgF;QAC7F,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE;QACpD,MAAM,EAAE,KAAK;KACd;IACD;QACE;;;;WAIG;QACH,IAAI,EAAE,0BAA0B;QAChC,KAAK,EAAE,iCAAiC;QACxC,WAAW,EAAE,gFAAgF;QAC7F,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;QACnD,MAAM,EAAE,KAAK;KACd;IACD;QACE;;;;WAIG;QACH,IAAI,EAAE,8BAA8B;QACpC,KAAK,EAAE,+CAA+C;QACtD,WAAW,EAAE,2EAA2E;QACxF,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;QAClD,MAAM,EAAE,IAAI;KACb;CACF,CAAA"}

package/dist/contract/permissions.d.ts

@@ -3,8 +3,19 @@
  * it by default. A workspace can add or remove any of them afterwards with a custom role.
  *
  * A key with nothing checking it is a role editor full of switches that do nothing, so these arrive
- * with the procedures that enforce them — `custody.manage`, `repair.manage`, `category.manage`,
- * `field.manage`, `value.view` and the stock and purchasing keys with their own phases.
+ * with the procedures that enforce them — `field.manage` and the stock and purchasing keys with
+ * their own phases.
+ *
+ * **Reading custody is `asset.view`, and that is a decision rather than an omission.** Who holds an
+ * item looks like a privacy question, and it is not one here: `custodianUserId` and `custodySince`
+ * are fields of `Asset`, returned by `assets.list` and `assets.get` under `asset.view` since the
+ * module existed, and `assets.list` has always taken a `custodianUserId` filter. A separate
+ * `custody.view` would be a lock on a door beside an open window — it would refuse the timeline
+ * while the row above it named the same person. "Who has the projector" is also the question an
+ * asset register exists to answer; a company where a member cannot find that out asks in chat
+ * instead, which is worse for whoever is holding it. A workspace that disagrees takes
+ * `inventory.asset.view` off `guest`, which is one switch and already there. Writing custody is
+ * `custody.manage`, because handing an item over makes somebody answerable for it.
  */
 export declare const inventoryPermissions: readonly [{
     readonly key: "inventory.asset.view";
@@ -18,5 +29,44 @@ export declare const inventoryPermissions: readonly [{
     readonly scope: "workspace";
     readonly defaultRoles: ["owner", "admin", "member"];
     readonly dangerous: false;
+}, {
+    /**
+     * Not `asset.manage`: correcting a serial number and making a colleague answerable for a
+     * £2,000 laptop are different acts, and plenty of workspaces want the first from everybody and
+     * the second from the office manager. Held by `member` by default all the same — an office
+     * where only an admin may hand over a charger keeps its register by not using it.
+     */
+    readonly key: "inventory.custody.manage";
+    readonly label: "Hand assets over and take them back";
+    readonly scope: "workspace";
+    readonly defaultRoles: ["owner", "admin", "member"];
+    readonly dangerous: false;
+}, {
+    /**
+     * Sending an item away and recording what it cost, held by `member` for the same reason
+     * `custody.manage` is: the person who notices a broken screen is the person who should be able
+     * to log it, and an office where only an admin may do that keeps its repair record by not
+     * keeping one. Reading repairs rides `asset.view` — "where is the projector" is the question
+     * the register exists to answer, and a repair is one of the two answers.
+     *
+     * Not folded into `asset.manage`: correcting a serial number and committing the company to a
+     * £400 screen replacement are different acts, and the money is why.
+     */
+    readonly key: "inventory.repair.manage";
+    readonly label: "Log repairs";
+    readonly scope: "workspace";
+    readonly defaultRoles: ["owner", "admin", "member"];
+    readonly dangerous: false;
+}, {
+    /**
+     * Categories are workspace configuration — one list everybody's assets are filed against — so
+     * this sits with the people who set the workspace up rather than with everybody who may edit an
+     * asset. Reading them rides `asset.view`, because the picker on the asset form needs them.
+     */
+    readonly key: "inventory.category.manage";
+    readonly label: "Manage asset categories";
+    readonly scope: "workspace";
+    readonly defaultRoles: ["owner", "admin"];
+    readonly dangerous: false;
 }];
 //# sourceMappingURL=permissions.d.ts.map

package/dist/contract/permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAe/B,CAAA"}
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;IAgB7B;;;;;OAKG;;;;;;;IAQH;;;;;;;;;OASG;;;;;;;IAQH;;;;OAIG;;;;;;EAOL,CAAA"}

package/dist/contract/permissions.js

@@ -4,8 +4,19 @@ import { definePermissions } from '@kernhq/contracts';
  * it by default. A workspace can add or remove any of them afterwards with a custom role.
  *
  * A key with nothing checking it is a role editor full of switches that do nothing, so these arrive
- * with the procedures that enforce them — `custody.manage`, `repair.manage`, `category.manage`,
- * `field.manage`, `value.view` and the stock and purchasing keys with their own phases.
+ * with the procedures that enforce them — `field.manage` and the stock and purchasing keys with
+ * their own phases.
+ *
+ * **Reading custody is `asset.view`, and that is a decision rather than an omission.** Who holds an
+ * item looks like a privacy question, and it is not one here: `custodianUserId` and `custodySince`
+ * are fields of `Asset`, returned by `assets.list` and `assets.get` under `asset.view` since the
+ * module existed, and `assets.list` has always taken a `custodianUserId` filter. A separate
+ * `custody.view` would be a lock on a door beside an open window — it would refuse the timeline
+ * while the row above it named the same person. "Who has the projector" is also the question an
+ * asset register exists to answer; a company where a member cannot find that out asks in chat
+ * instead, which is worse for whoever is holding it. A workspace that disagrees takes
+ * `inventory.asset.view` off `guest`, which is one switch and already there. Writing custody is
+ * `custody.manage`, because handing an item over makes somebody answerable for it.
  */
 export const inventoryPermissions = definePermissions([
     {
@@ -22,5 +33,47 @@ export const inventoryPermissions = definePermissions([
         defaultRoles: ['owner', 'admin', 'member'],
         dangerous: false,
     },
+    {
+        /**
+         * Not `asset.manage`: correcting a serial number and making a colleague answerable for a
+         * £2,000 laptop are different acts, and plenty of workspaces want the first from everybody and
+         * the second from the office manager. Held by `member` by default all the same — an office
+         * where only an admin may hand over a charger keeps its register by not using it.
+         */
+        key: 'inventory.custody.manage',
+        label: 'Hand assets over and take them back',
+        scope: 'workspace',
+        defaultRoles: ['owner', 'admin', 'member'],
+        dangerous: false,
+    },
+    {
+        /**
+         * Sending an item away and recording what it cost, held by `member` for the same reason
+         * `custody.manage` is: the person who notices a broken screen is the person who should be able
+         * to log it, and an office where only an admin may do that keeps its repair record by not
+         * keeping one. Reading repairs rides `asset.view` — "where is the projector" is the question
+         * the register exists to answer, and a repair is one of the two answers.
+         *
+         * Not folded into `asset.manage`: correcting a serial number and committing the company to a
+         * £400 screen replacement are different acts, and the money is why.
+         */
+        key: 'inventory.repair.manage',
+        label: 'Log repairs',
+        scope: 'workspace',
+        defaultRoles: ['owner', 'admin', 'member'],
+        dangerous: false,
+    },
+    {
+        /**
+         * Categories are workspace configuration — one list everybody's assets are filed against — so
+         * this sits with the people who set the workspace up rather than with everybody who may edit an
+         * asset. Reading them rides `asset.view`, because the picker on the asset form needs them.
+         */
+        key: 'inventory.category.manage',
+        label: 'Manage asset categories',
+        scope: 'workspace',
+        defaultRoles: ['owner', 'admin'],
+        dangerous: false,
+    },
 ]);
 //# sourceMappingURL=permissions.js.map

package/dist/contract/permissions.js.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD;QACE,GAAG,EAAE,sBAAsB;QAC3B,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACnD,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,wBAAwB;QAC7B,KAAK,EAAE,wBAAwB;QAC/B,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;CACF,CAAC,CAAA"}
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD;QACE,GAAG,EAAE,sBAAsB;QAC3B,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACnD,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,wBAAwB;QAC7B,KAAK,EAAE,wBAAwB;QAC/B,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;IACD;QACE;;;;;WAKG;QACH,GAAG,EAAE,0BAA0B;QAC/B,KAAK,EAAE,qCAAqC;QAC5C,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;IACD;QACE;;;;;;;;;WASG;QACH,GAAG,EAAE,yBAAyB;QAC9B,KAAK,EAAE,aAAa;QACpB,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;IACD;QACE;;;;WAIG;QACH,GAAG,EAAE,2BAA2B;QAChC,KAAK,EAAE,yBAAyB;QAChC,KAAK,EAAE,WAAW;QAClB,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;QAChC,SAAS,EAAE,KAAK;KACjB;CACF,CAAC,CAAA"}