@phis/contracts 0.7.0 → 0.7.2

package/README.md

@@ -4,6 +4,13 @@ The agreements phis (`@phis/server`) keeps with what surrounds it: the site UI (
 separately shipped Add-ons. Each lives under its own subpath, because they hold between different parties
 and change at different moments.
 
+> **Part of phis.** This package is one piece of a larger whole and does nothing on its own. A Phi
+> installation is the server [`@phis/server`](https://github.com/phis-dev/phis-server), installed as the
+> Debian package `phis` from `apt.phisys.com` (not from npm), plus Sites built on
+> [`@phis/ui`](https://github.com/phis-dev/phis-ui), which brings this package along. Installation and
+> documentation: [phis.dev](https://phis.dev). Install it directly only to build an Add-on or a Module
+> against these contracts.
+
 ```
 @phis/contracts/addon                what phis and a separately shipped Add-on promise each other
 @phis/contracts/payments             the approved Payment consumer, Provider and merchant-profile types

package/dist/cms.d.ts

@@ -96,6 +96,11 @@ export declare const PhiCmsFlags: {
     readonly FullHeight: number;
     /** A Sider the viewer can fold to its collapsed width. */
     readonly Collapsible: number;
+    /**
+     * A Sider that leaves its column on a phone and opens from the side, over the page, from the Shell's
+     * menu button. Placed above the Overlay bits, which were assigned first.
+     */
+    readonly MobileDrawer: number;
     /** The Header chrome renders no close button. */
     readonly NoCloseButton: number;
     /** Escape does not request dismissal. */

package/dist/cms.js

@@ -108,6 +108,11 @@ export const PhiCmsFlags = {
     FullHeight: 1 << 8,
     /** A Sider the viewer can fold to its collapsed width. */
     Collapsible: 1 << 9,
+    /**
+     * A Sider that leaves its column on a phone and opens from the side, over the page, from the Shell's
+     * menu button. Placed above the Overlay bits, which were assigned first.
+     */
+    MobileDrawer: 1 << 17,
     /*
      * An Overlay's behaviour, carried in its config's `flags` the same way. The bits name the departure
      * from the Overlay's defaults, so an unset flag set is the plain Overlay: a close button, Escape

package/dist/queries.d.ts

@@ -84,6 +84,20 @@ export type PhisAddonQueryCondition = {
     column: string;
     negated?: boolean;
 }
+/**
+ * Whether bits of a flags column are set: every bit of `mask` (`all`), or none of them (`none`).
+ *
+ * Yes/no state is kept as bit flags rather than boolean columns, so "the rows that are not a draft"
+ * is a question about one bit of an integer. `compare` cannot ask it -- `=` sees the whole number --
+ * and without this an Add-on reads every row and filters in code, which also breaks paging: a page of
+ * 25 comes back with fewer. The mask is a positive integer; the column is an integer column.
+ */
+ | {
+    kind: "flags";
+    column: string;
+    mask: PhisAddonQueryValue;
+    match: "all" | "none";
+}
 /**
  * Whether a text column contains this fragment, case-insensitively.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phis/contracts",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "license": "Apache-2.0",
   "type": "module",
   "publishConfig": {
@@ -140,7 +140,7 @@
     "type": "git",
     "url": "git+https://github.com/phis-dev/phis-contracts.git"
   },
-  "homepage": "https://github.com/phis-dev/phis-contracts#readme",
+  "homepage": "https://phis.dev",
   "bugs": {
     "url": "https://github.com/phis-dev/phis-contracts/issues"
   }