@phis/contracts 0.4.0 → 0.6.0

package/dist/timeline.js

@@ -0,0 +1,53 @@
+/**
+ * What a Timeline shows, the same for a Widget's own entries and for a Timeline Provider's answer.
+ *
+ * A Provider may run in a Module of ours, in an outside Module, or answer from an Add-on behind a Site
+ * route, so the entry is spelled here rather than in the UI package: every end that hands entries over
+ * reads and writes this shape.
+ */
+/** What an entry's mark says about it: a word about meaning, so the Theme decides the colour. */
+export const PHI_TIMELINE_TONES = ["secondary", "success", "warning", "danger"];
+function readString(value) {
+    return typeof value === "string" && value.trim().length > 0 ? value.trim() : undefined;
+}
+export function isPhiTimelineTone(value) {
+    return typeof value === "string" && PHI_TIMELINE_TONES.includes(value);
+}
+/**
+ * The `at` of an entry, when it is a date this reader can place. A string that is not one is dropped
+ * rather than shown: an unreadable instant would print as "Invalid Date" in the reader's language.
+ */
+function readInstant(value) {
+    const text = readString(value);
+    return text && !Number.isNaN(Date.parse(text)) ? text : undefined;
+}
+/** One entry, or `null` for anything that is not one. An entry without a key or text is not one. */
+export function readPhiTimelineEntry(value) {
+    if (!value || typeof value !== "object" || Array.isArray(value)) {
+        return null;
+    }
+    const record = value;
+    const key = readString(record.key);
+    if (!key) {
+        return null;
+    }
+    const title = readString(record.title);
+    const at = readInstant(record.at);
+    const time = readString(record.time);
+    const icon = readString(record.icon);
+    return {
+        key,
+        content: typeof record.content === "string" ? record.content : "",
+        ...(title ? { title } : {}),
+        ...(at ? { at } : {}),
+        ...(time ? { time } : {}),
+        ...(icon ? { icon } : {}),
+        ...(isPhiTimelineTone(record.tone) ? { tone: record.tone } : {}),
+        ...(record.pending === true ? { pending: true } : {}),
+    };
+}
+export function readPhiTimelineEntries(value) {
+    return Array.isArray(value)
+        ? value.map(readPhiTimelineEntry).filter((entry) => entry != null)
+        : [];
+}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@phis/contracts",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "license": "Apache-2.0",
   "type": "module",
   "publishConfig": {
     "access": "public"
   },
   "sideEffects": false,
-  "description": "The agreements phis keeps with the site UI, Sites and Add-ons: the Add-on ABI, access, signals, catalog, CMS identity, media, HTTP headers, locale, logging, capabilities and group levels.",
+  "description": "The agreements phis keeps with the site UI, Sites and Add-ons: the Add-on ABI, access, signals, conditions, forms, controls, layout, catalog, CMS identity, media, HTTP headers, locale, logging, capabilities and group levels.",
   "scripts": {
     "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit",
@@ -15,6 +15,16 @@
     "prepack": "npm run build"
   },
   "exports": {
+    "./payments": {
+      "types": "./dist/payments.d.ts",
+      "import": "./dist/payments.js",
+      "default": "./dist/payments.js"
+    },
+    "./references": {
+      "types": "./dist/references.d.ts",
+      "import": "./dist/references.js",
+      "default": "./dist/references.js"
+    },
     "./addon": {
       "types": "./dist/addon-index.d.ts",
       "import": "./dist/addon-index.js",
@@ -89,6 +99,31 @@
       "types": "./dist/user-state.d.ts",
       "import": "./dist/user-state.js",
       "default": "./dist/user-state.js"
+    },
+    "./conditions": {
+      "types": "./dist/conditions.d.ts",
+      "import": "./dist/conditions.js",
+      "default": "./dist/conditions.js"
+    },
+    "./controls": {
+      "types": "./dist/controls.d.ts",
+      "import": "./dist/controls.js",
+      "default": "./dist/controls.js"
+    },
+    "./forms": {
+      "types": "./dist/forms.d.ts",
+      "import": "./dist/forms.js",
+      "default": "./dist/forms.js"
+    },
+    "./layout": {
+      "types": "./dist/layout.d.ts",
+      "import": "./dist/layout.js",
+      "default": "./dist/layout.js"
+    },
+    "./timeline": {
+      "types": "./dist/timeline.d.ts",
+      "import": "./dist/timeline.js",
+      "default": "./dist/timeline.js"
     }
   },
   "files": [