@aglyn/plugins-workflows 1.0.0-beta.219 → 1.0.0-beta.221

package/src/lib/testing/stand-in-overlay-list.js

@@ -0,0 +1,53 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { registerPluginRecordListSource } from "@aglyn/aglyn/plugin-manager/plugin-record-lists";
+import { collection, documentId, limit, orderBy, query } from "firebase/firestore";
+/**
+ * The `overlay` list source the plugin that keeps a site's announcement bars
+ * and popups publishes (AGL-3080), stood in for this plugin's specs — this
+ * plugin may not load the marketing plugin. It builds the query that plugin's
+ * `overlay-record-list.ts` builds (the site's overlays, ordered by document
+ * id) from whatever `firebase/firestore` the spec stages, and reads a row as
+ * a live overlay named by its name, its bar's text or its popup's headline.
+ * What the marketing plugin itself answers is held in its own spec.
+ */ export function standInOverlayList() {
+    registerPluginRecordListSource('overlay', {
+        query (firestore, request) {
+            if (!request.hostId) return null;
+            return query(collection(firestore, 'hosts', request.hostId, 'overlays'), orderBy(documentId()), limit(request.limit));
+        },
+        record (id, data) {
+            var _data_bar, _data_popup;
+            if (!data || data['deletedAt'] != null) return null;
+            const bar = (_data_bar = data['bar']) != null ? _data_bar : {};
+            const popup = (_data_popup = data['popup']) != null ? _data_popup : {};
+            const name = [
+                data['name'],
+                bar['text'],
+                popup['headline']
+            ].find((value)=>typeof value === 'string' && value.trim());
+            return {
+                id,
+                name: typeof name === 'string' ? name.trim() : id,
+                facts: {}
+            };
+        }
+    }, {
+        pluginId: 'marketing'
+    });
+}
+
+//# sourceMappingURL=stand-in-overlay-list.js.map

package/src/lib/testing/stand-in-overlay-list.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/workflows/src/lib/testing/stand-in-overlay-list.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { registerPluginRecordListSource } from '@aglyn/aglyn/plugin-manager/plugin-record-lists'\nimport { collection, documentId, limit, orderBy, query } from 'firebase/firestore'\n\n/**\n * The `overlay` list source the plugin that keeps a site's announcement bars\n * and popups publishes (AGL-3080), stood in for this plugin's specs — this\n * plugin may not load the marketing plugin. It builds the query that plugin's\n * `overlay-record-list.ts` builds (the site's overlays, ordered by document\n * id) from whatever `firebase/firestore` the spec stages, and reads a row as\n * a live overlay named by its name, its bar's text or its popup's headline.\n * What the marketing plugin itself answers is held in its own spec.\n */\nexport function standInOverlayList(): void {\n  registerPluginRecordListSource(\n    'overlay',\n    {\n      query(firestore, request) {\n        if (!request.hostId) return null\n        return query(\n          collection(firestore, 'hosts', request.hostId, 'overlays'),\n          orderBy(documentId()),\n          limit(request.limit),\n        )\n      },\n      record(id, data) {\n        if (!data || data['deletedAt'] != null) return null\n        const bar = (data['bar'] ?? {}) as Record<string, unknown>\n        const popup = (data['popup'] ?? {}) as Record<string, unknown>\n        const name = [data['name'], bar['text'], popup['headline']].find(\n          (value) => typeof value === 'string' && value.trim(),\n        )\n        return { id, name: typeof name === 'string' ? name.trim() : id, facts: {} }\n      },\n    },\n    { pluginId: 'marketing' },\n  )\n}\n"],"names":["registerPluginRecordListSource","collection","documentId","limit","orderBy","query","standInOverlayList","firestore","request","hostId","record","id","data","bar","popup","name","find","value","trim","facts","pluginId"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,8BAA8B,QAAQ,kDAAiD;AAChG,SAASC,UAAU,EAAEC,UAAU,EAAEC,KAAK,EAAEC,OAAO,EAAEC,KAAK,QAAQ,qBAAoB;AAElF;;;;;;;;CAQC,GACD,OAAO,SAASC;IACdN,+BACE,WACA;QACEK,OAAME,SAAS,EAAEC,OAAO;YACtB,IAAI,CAACA,QAAQC,MAAM,EAAE,OAAO;YAC5B,OAAOJ,MACLJ,WAAWM,WAAW,SAASC,QAAQC,MAAM,EAAE,aAC/CL,QAAQF,eACRC,MAAMK,QAAQL,KAAK;QAEvB;QACAO,QAAOC,EAAE,EAAEC,IAAI;gBAEAA,WACEA;YAFf,IAAI,CAACA,QAAQA,IAAI,CAAC,YAAY,IAAI,MAAM,OAAO;YAC/C,MAAMC,OAAOD,YAAAA,IAAI,CAAC,MAAM,YAAXA,YAAe,CAAC;YAC7B,MAAME,SAASF,cAAAA,IAAI,CAAC,QAAQ,YAAbA,cAAiB,CAAC;YACjC,MAAMG,OAAO;gBAACH,IAAI,CAAC,OAAO;gBAAEC,GAAG,CAAC,OAAO;gBAAEC,KAAK,CAAC,WAAW;aAAC,CAACE,IAAI,CAC9D,CAACC,QAAU,OAAOA,UAAU,YAAYA,MAAMC,IAAI;YAEpD,OAAO;gBAAEP;gBAAII,MAAM,OAAOA,SAAS,WAAWA,KAAKG,IAAI,KAAKP;gBAAIQ,OAAO,CAAC;YAAE;QAC5E;IACF,GACA;QAAEC,UAAU;IAAY;AAE5B"}

package/src/lib/usage-axes.d.ts

@@ -23,6 +23,6 @@ import type { PluginUsageAxesDeclaration } from '@aglyn/aglyn/plugin-manager/plu
  * ONE cost axis for both counters: a run is the same handful of reads, two
  * writes and a moment of compute whichever builder produced it, so both are
  * priced at `perRun` on one line. TWO bands, because each builder sells its
- * own.
+ * own; the workflow band also warns the workspace as it fills.
  */
 export declare function workflowsUsageAxes(): PluginUsageAxesDeclaration;

package/src/lib/usage-axes.js

@@ -21,7 +21,7 @@
  * ONE cost axis for both counters: a run is the same handful of reads, two
  * writes and a moment of compute whichever builder produced it, so both are
  * priced at `perRun` on one line. TWO bands, because each builder sells its
- * own.
+ * own; the workflow band also warns the workspace as it fills.
  */ export function workflowsUsageAxes() {
     return {
         costAxes: [
@@ -43,7 +43,18 @@
                 fields: [
                     'workflowRuns'
                 ],
-                entitlement: 'workflowRunsPerMonth'
+                entitlement: 'workflowRunsPerMonth',
+                hostCounter: 'workflowRuns',
+                // The runtime stops workflows silently at the monthly cap, so the
+                // owner is warned approaching it and told on reaching it why their
+                // automations went quiet.
+                alert: {
+                    label: 'monthly workflow runs',
+                    noun: 'workflow runs',
+                    outcome: 'stops',
+                    reached: 'Workflows pause until next month and nothing is charged — ' + 'upgrade in Billing to keep them running.',
+                    approach: 'Nothing changes and nothing is charged — at the included amount, ' + 'workflows pause until next month unless you upgrade in Billing.'
+                }
             },
             {
                 id: 'actionRuns',

package/src/lib/usage-axes.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../libs/plugins/workflows/src/lib/usage-axes.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { PluginUsageAxesDeclaration } from '@aglyn/aglyn/plugin-manager/plugin-usage-axes'\n\n/**\n * THE WORKFLOWS PLUGIN'S METERS (AGL-3080): workflow and action runs, in the\n * platform's cost model and utilization table. Compiled into core by the\n * manifest generator (`register.usageAxes`).\n *\n * ONE cost axis for both counters: a run is the same handful of reads, two\n * writes and a moment of compute whichever builder produced it, so both are\n * priced at `perRun` on one line. TWO bands, because each builder sells its\n * own.\n */\nexport function workflowsUsageAxes(): PluginUsageAxesDeclaration {\n  return {\n    costAxes: [\n      {\n        id: 'runs',\n        order: 90,\n        fields: ['workflowRuns', 'actionRuns'],\n        rate: 'perRun',\n      },\n    ],\n    bands: [\n      {\n        id: 'workflowRuns',\n        label: 'Workflow runs',\n        order: 100,\n        fields: ['workflowRuns'],\n        entitlement: 'workflowRunsPerMonth',\n      },\n      {\n        id: 'actionRuns',\n        label: 'Action runs',\n        order: 110,\n        fields: ['actionRuns'],\n        entitlement: 'actionRunsPerMonth',\n      },\n    ],\n  }\n}\n"],"names":["workflowsUsageAxes","costAxes","id","order","fields","rate","bands","label","entitlement"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAID;;;;;;;;;CASC,GACD,OAAO,SAASA;IACd,OAAO;QACLC,UAAU;YACR;gBACEC,IAAI;gBACJC,OAAO;gBACPC,QAAQ;oBAAC;oBAAgB;iBAAa;gBACtCC,MAAM;YACR;SACD;QACDC,OAAO;YACL;gBACEJ,IAAI;gBACJK,OAAO;gBACPJ,OAAO;gBACPC,QAAQ;oBAAC;iBAAe;gBACxBI,aAAa;YACf;YACA;gBACEN,IAAI;gBACJK,OAAO;gBACPJ,OAAO;gBACPC,QAAQ;oBAAC;iBAAa;gBACtBI,aAAa;YACf;SACD;IACH;AACF"}
+{"version":3,"sources":["../../../../../../libs/plugins/workflows/src/lib/usage-axes.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { PluginUsageAxesDeclaration } from '@aglyn/aglyn/plugin-manager/plugin-usage-axes'\n\n/**\n * THE WORKFLOWS PLUGIN'S METERS (AGL-3080): workflow and action runs, in the\n * platform's cost model and utilization table. Compiled into core by the\n * manifest generator (`register.usageAxes`).\n *\n * ONE cost axis for both counters: a run is the same handful of reads, two\n * writes and a moment of compute whichever builder produced it, so both are\n * priced at `perRun` on one line. TWO bands, because each builder sells its\n * own; the workflow band also warns the workspace as it fills.\n */\nexport function workflowsUsageAxes(): PluginUsageAxesDeclaration {\n  return {\n    costAxes: [\n      {\n        id: 'runs',\n        order: 90,\n        fields: ['workflowRuns', 'actionRuns'],\n        rate: 'perRun',\n      },\n    ],\n    bands: [\n      {\n        id: 'workflowRuns',\n        label: 'Workflow runs',\n        order: 100,\n        fields: ['workflowRuns'],\n        entitlement: 'workflowRunsPerMonth',\n        hostCounter: 'workflowRuns',\n        // The runtime stops workflows silently at the monthly cap, so the\n        // owner is warned approaching it and told on reaching it why their\n        // automations went quiet.\n        alert: {\n          label: 'monthly workflow runs',\n          noun: 'workflow runs',\n          outcome: 'stops',\n          reached:\n            'Workflows pause until next month and nothing is charged — ' +\n            'upgrade in Billing to keep them running.',\n          approach:\n            'Nothing changes and nothing is charged — at the included amount, ' +\n            'workflows pause until next month unless you upgrade in Billing.',\n        },\n      },\n      {\n        id: 'actionRuns',\n        label: 'Action runs',\n        order: 110,\n        fields: ['actionRuns'],\n        entitlement: 'actionRunsPerMonth',\n      },\n    ],\n  }\n}\n"],"names":["workflowsUsageAxes","costAxes","id","order","fields","rate","bands","label","entitlement","hostCounter","alert","noun","outcome","reached","approach"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAID;;;;;;;;;CASC,GACD,OAAO,SAASA;IACd,OAAO;QACLC,UAAU;YACR;gBACEC,IAAI;gBACJC,OAAO;gBACPC,QAAQ;oBAAC;oBAAgB;iBAAa;gBACtCC,MAAM;YACR;SACD;QACDC,OAAO;YACL;gBACEJ,IAAI;gBACJK,OAAO;gBACPJ,OAAO;gBACPC,QAAQ;oBAAC;iBAAe;gBACxBI,aAAa;gBACbC,aAAa;gBACb,kEAAkE;gBAClE,mEAAmE;gBACnE,0BAA0B;gBAC1BC,OAAO;oBACLH,OAAO;oBACPI,MAAM;oBACNC,SAAS;oBACTC,SACE,+DACA;oBACFC,UACE,sEACA;gBACJ;YACF;YACA;gBACEZ,IAAI;gBACJK,OAAO;gBACPJ,OAAO;gBACPC,QAAQ;oBAAC;iBAAa;gBACtBI,aAAa;YACf;SACD;IACH;AACF"}