@aglyn/aglyn 1.0.0-beta.143

package/src/lib/plugin-manager/usage-alert-contributors.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @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.
+ */
+/**
+ * Staff alerts a plugin contributes to the usage-alerts sweep (AGL-2984).
+ *
+ * The usage-alerts cron walks every org, reads its usage once, and sends
+ * core's own alerts: the plan quotas, the customer's budget and the free
+ * plan's bandwidth cap. A plugin that meters a cost or enforces a ceiling
+ * core knows nothing about registers a contributor here from its
+ * `serverDeclarations` entry, and the sweep hands the contributor each org's
+ * reading after the budget alert and before the bandwidth cap.
+ *
+ * THE PIPELINE IS THE SWEEP'S. A contributor decides whether an alert is due
+ * and what it says; the context does everything else:
+ *
+ * - `recordAlert(key, threshold)` records the dedupe guard and answers
+ *   whether the alert may be SENT. On an org's first, silent evaluation it
+ *   records the guard as though the alert went out and answers `false`, so a
+ *   contributor that sends only on `true` honors the first-sweep seeding
+ *   without knowing when it applies.
+ * - `alertStaff(alert)` is the sweep's own sender: the staff bell, then the
+ *   staff inbox, then a row in the run's report saying whether the mail went
+ *   out. On an org's first, silent evaluation it sends nothing, whoever calls
+ *   it.
+ * - `guards` is the org's guard map as the sweep read it. A contributor reads
+ *   it to dedupe and never writes a guard itself: the sweep writes what
+ *   `recordAlert` recorded, once, with the rest of the org's update.
+ *
+ * Guard keys share one map with core's own checks (`hosts`, `bandwidth`,
+ * `budget` and the rest), so a contributor names its keys for what it
+ * measures and never reuses one of core's.
+ *
+ * Contributors run one at a time and are ISOLATED: a throw is logged against
+ * the contributor and the next one runs. A guard the failed contributor
+ * recorded for an alert it never delivered is dropped rather than written, so
+ * the next sweep tries that alert again instead of counting it as announced.
+ * One plugin's failure costs no other plugin's alert, none of core's, and not
+ * the rest of the sweep.
+ *
+ * The order is deterministic: the catalog order of `FIRST_PARTY_PLUGINS`,
+ * then any other plugin id in code-unit order, then registration order within
+ * a plugin. The order contributors REGISTER in depends on how each process
+ * loaded the declarations, and a list that followed it could send and report
+ * one org's alerts in a different order per process.
+ */
+import type { OrgSpendBreakdown, UsageAlertGuard } from '../app-utils/usage-budget';
+/** One staff alert, as the sweep delivers and reports it. */
+export interface UsageStaffAlert {
+    /** The guard key the alert was recorded under; the report row's `quota`. */
+    quota: string;
+    /** The threshold passed to `recordAlert`; the report row's `threshold`. */
+    threshold: number;
+    /** The bell's title and the email's subject: one set of words for both. */
+    title: string;
+    /** The bell's body. The email carries it verbatim, followed by the link. */
+    body: string;
+    /** A console path. The bell links it; the email makes it absolute. */
+    link: string;
+    /** The email's tag and log label. */
+    emailContext: string;
+}
+/** What the sweep hands a contributor for one org. */
+export interface UsageAlertContext {
+    orgId: string;
+    /** The org's slug, or `null` when the document carries none. */
+    orgSlug: string | null;
+    /** The org document as the sweep read it. */
+    org: Readonly<Record<string, unknown>>;
+    /** The `YYYY-MM` month the sweep dedupes against, fixed for the whole run. */
+    month: string;
+    /** The org's spend this month, built from the figures the sweep read. */
+    spend: Readonly<OrgSpendBreakdown>;
+    /** The org's guard map as the sweep read it, before this run's updates. */
+    guards: Readonly<Record<string, Readonly<UsageAlertGuard>>>;
+    /**
+     * Records the guard for `key` at `threshold` and answers whether the alert
+     * may be sent. Call it once the alert is due, and send only on `true`.
+     */
+    recordAlert: (key: string, threshold: number) => boolean;
+    /** Delivers one staff alert through the sweep's senders and reports it. */
+    alertStaff: (alert: UsageStaffAlert) => Promise<void>;
+}
+/** A plugin's rule for the usage-alerts sweep. */
+export interface UsageAlertContributor {
+    pluginId: string;
+    /** Unique within the plugin; two plugins may use the same id. */
+    id: string;
+    /** Evaluates one org, sending only through the context. */
+    evaluate: (context: UsageAlertContext) => Promise<void>;
+}
+/**
+ * Registers a contributor. Idempotent per plugin and id: registering the same
+ * pair again replaces the earlier contributor in place, so a declarations
+ * module evaluated twice does not alert twice. A contributor with no plugin,
+ * no id or no `evaluate` throws.
+ */
+export declare function registerUsageAlertContributor(contributor: UsageAlertContributor): void;
+/** Every registered contributor, in the order the sweep runs them. */
+export declare function listUsageAlertContributors(): UsageAlertContributor[];
+/** Test seam: forget every contributor. */
+export declare function resetUsageAlertContributorsForTests(): void;

package/src/lib/plugin-manager/usage-alert-contributors.js

@@ -0,0 +1,106 @@
+/**
+ * @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.
+ */ /**
+ * Staff alerts a plugin contributes to the usage-alerts sweep (AGL-2984).
+ *
+ * The usage-alerts cron walks every org, reads its usage once, and sends
+ * core's own alerts: the plan quotas, the customer's budget and the free
+ * plan's bandwidth cap. A plugin that meters a cost or enforces a ceiling
+ * core knows nothing about registers a contributor here from its
+ * `serverDeclarations` entry, and the sweep hands the contributor each org's
+ * reading after the budget alert and before the bandwidth cap.
+ *
+ * THE PIPELINE IS THE SWEEP'S. A contributor decides whether an alert is due
+ * and what it says; the context does everything else:
+ *
+ * - `recordAlert(key, threshold)` records the dedupe guard and answers
+ *   whether the alert may be SENT. On an org's first, silent evaluation it
+ *   records the guard as though the alert went out and answers `false`, so a
+ *   contributor that sends only on `true` honors the first-sweep seeding
+ *   without knowing when it applies.
+ * - `alertStaff(alert)` is the sweep's own sender: the staff bell, then the
+ *   staff inbox, then a row in the run's report saying whether the mail went
+ *   out. On an org's first, silent evaluation it sends nothing, whoever calls
+ *   it.
+ * - `guards` is the org's guard map as the sweep read it. A contributor reads
+ *   it to dedupe and never writes a guard itself: the sweep writes what
+ *   `recordAlert` recorded, once, with the rest of the org's update.
+ *
+ * Guard keys share one map with core's own checks (`hosts`, `bandwidth`,
+ * `budget` and the rest), so a contributor names its keys for what it
+ * measures and never reuses one of core's.
+ *
+ * Contributors run one at a time and are ISOLATED: a throw is logged against
+ * the contributor and the next one runs. A guard the failed contributor
+ * recorded for an alert it never delivered is dropped rather than written, so
+ * the next sweep tries that alert again instead of counting it as announced.
+ * One plugin's failure costs no other plugin's alert, none of core's, and not
+ * the rest of the sweep.
+ *
+ * The order is deterministic: the catalog order of `FIRST_PARTY_PLUGINS`,
+ * then any other plugin id in code-unit order, then registration order within
+ * a plugin. The order contributors REGISTER in depends on how each process
+ * loaded the declarations, and a list that followed it could send and report
+ * one org's alerts in a different order per process.
+ */ import { _ as _extends } from "@swc/helpers/_/_extends";
+import { FIRST_PARTY_PLUGINS } from "./enabled-plugins.js";
+const registrations = [];
+const CATALOG_ORDER = new Map(FIRST_PARTY_PLUGINS.map((plugin, index)=>[
+        plugin.id,
+        index
+    ]));
+function catalogRank(pluginId) {
+    var _CATALOG_ORDER_get;
+    return (_CATALOG_ORDER_get = CATALOG_ORDER.get(pluginId)) != null ? _CATALOG_ORDER_get : Number.MAX_SAFE_INTEGER;
+}
+/** Code-unit order, which no locale can reorder. */ function codeUnitOrder(a, b) {
+    return a < b ? -1 : a > b ? 1 : 0;
+}
+/**
+ * Registers a contributor. Idempotent per plugin and id: registering the same
+ * pair again replaces the earlier contributor in place, so a declarations
+ * module evaluated twice does not alert twice. A contributor with no plugin,
+ * no id or no `evaluate` throws.
+ */ export function registerUsageAlertContributor(contributor) {
+    var _contributor_pluginId, _contributor_id;
+    const pluginId = String((_contributor_pluginId = contributor.pluginId) != null ? _contributor_pluginId : '').trim();
+    const id = String((_contributor_id = contributor.id) != null ? _contributor_id : '').trim();
+    if (!pluginId || !id) {
+        throw new Error('a usage alert contributor needs a pluginId and an id');
+    }
+    if (typeof contributor.evaluate !== 'function') {
+        throw new Error(`usage alert contributor "${pluginId}:${id}" has no evaluate function`);
+    }
+    const entry = {
+        pluginId,
+        id,
+        evaluate: contributor.evaluate
+    };
+    const index = registrations.findIndex((existing)=>existing.pluginId === pluginId && existing.id === id);
+    if (index >= 0) registrations[index] = entry;
+    else registrations.push(entry);
+}
+/** Every registered contributor, in the order the sweep runs them. */ export function listUsageAlertContributors() {
+    return registrations.map((entry, sequence)=>({
+            entry,
+            sequence
+        })).sort((a, b)=>catalogRank(a.entry.pluginId) - catalogRank(b.entry.pluginId) || codeUnitOrder(a.entry.pluginId, b.entry.pluginId) || a.sequence - b.sequence).map(({ entry })=>_extends({}, entry));
+}
+/** Test seam: forget every contributor. */ export function resetUsageAlertContributorsForTests() {
+    registrations.length = 0;
+}
+
+//# sourceMappingURL=usage-alert-contributors.js.map

package/src/lib/plugin-manager/usage-alert-contributors.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/aglyn/src/lib/plugin-manager/usage-alert-contributors.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\n/**\n * Staff alerts a plugin contributes to the usage-alerts sweep (AGL-2984).\n *\n * The usage-alerts cron walks every org, reads its usage once, and sends\n * core's own alerts: the plan quotas, the customer's budget and the free\n * plan's bandwidth cap. A plugin that meters a cost or enforces a ceiling\n * core knows nothing about registers a contributor here from its\n * `serverDeclarations` entry, and the sweep hands the contributor each org's\n * reading after the budget alert and before the bandwidth cap.\n *\n * THE PIPELINE IS THE SWEEP'S. A contributor decides whether an alert is due\n * and what it says; the context does everything else:\n *\n * - `recordAlert(key, threshold)` records the dedupe guard and answers\n *   whether the alert may be SENT. On an org's first, silent evaluation it\n *   records the guard as though the alert went out and answers `false`, so a\n *   contributor that sends only on `true` honors the first-sweep seeding\n *   without knowing when it applies.\n * - `alertStaff(alert)` is the sweep's own sender: the staff bell, then the\n *   staff inbox, then a row in the run's report saying whether the mail went\n *   out. On an org's first, silent evaluation it sends nothing, whoever calls\n *   it.\n * - `guards` is the org's guard map as the sweep read it. A contributor reads\n *   it to dedupe and never writes a guard itself: the sweep writes what\n *   `recordAlert` recorded, once, with the rest of the org's update.\n *\n * Guard keys share one map with core's own checks (`hosts`, `bandwidth`,\n * `budget` and the rest), so a contributor names its keys for what it\n * measures and never reuses one of core's.\n *\n * Contributors run one at a time and are ISOLATED: a throw is logged against\n * the contributor and the next one runs. A guard the failed contributor\n * recorded for an alert it never delivered is dropped rather than written, so\n * the next sweep tries that alert again instead of counting it as announced.\n * One plugin's failure costs no other plugin's alert, none of core's, and not\n * the rest of the sweep.\n *\n * The order is deterministic: the catalog order of `FIRST_PARTY_PLUGINS`,\n * then any other plugin id in code-unit order, then registration order within\n * a plugin. The order contributors REGISTER in depends on how each process\n * loaded the declarations, and a list that followed it could send and report\n * one org's alerts in a different order per process.\n */\n\nimport type {\n  OrgSpendBreakdown,\n  UsageAlertGuard,\n} from '../app-utils/usage-budget'\nimport { FIRST_PARTY_PLUGINS } from './enabled-plugins'\n\n/** One staff alert, as the sweep delivers and reports it. */\nexport interface UsageStaffAlert {\n  /** The guard key the alert was recorded under; the report row's `quota`. */\n  quota: string\n  /** The threshold passed to `recordAlert`; the report row's `threshold`. */\n  threshold: number\n  /** The bell's title and the email's subject: one set of words for both. */\n  title: string\n  /** The bell's body. The email carries it verbatim, followed by the link. */\n  body: string\n  /** A console path. The bell links it; the email makes it absolute. */\n  link: string\n  /** The email's tag and log label. */\n  emailContext: string\n}\n\n/** What the sweep hands a contributor for one org. */\nexport interface UsageAlertContext {\n  orgId: string\n  /** The org's slug, or `null` when the document carries none. */\n  orgSlug: string | null\n  /** The org document as the sweep read it. */\n  org: Readonly<Record<string, unknown>>\n  /** The `YYYY-MM` month the sweep dedupes against, fixed for the whole run. */\n  month: string\n  /** The org's spend this month, built from the figures the sweep read. */\n  spend: Readonly<OrgSpendBreakdown>\n  /** The org's guard map as the sweep read it, before this run's updates. */\n  guards: Readonly<Record<string, Readonly<UsageAlertGuard>>>\n  /**\n   * Records the guard for `key` at `threshold` and answers whether the alert\n   * may be sent. Call it once the alert is due, and send only on `true`.\n   */\n  recordAlert: (key: string, threshold: number) => boolean\n  /** Delivers one staff alert through the sweep's senders and reports it. */\n  alertStaff: (alert: UsageStaffAlert) => Promise<void>\n}\n\n/** A plugin's rule for the usage-alerts sweep. */\nexport interface UsageAlertContributor {\n  pluginId: string\n  /** Unique within the plugin; two plugins may use the same id. */\n  id: string\n  /** Evaluates one org, sending only through the context. */\n  evaluate: (context: UsageAlertContext) => Promise<void>\n}\n\nconst registrations: UsageAlertContributor[] = []\n\nconst CATALOG_ORDER = new Map(\n  FIRST_PARTY_PLUGINS.map((plugin, index) => [plugin.id, index]),\n)\n\nfunction catalogRank(pluginId: string): number {\n  return CATALOG_ORDER.get(pluginId) ?? Number.MAX_SAFE_INTEGER\n}\n\n/** Code-unit order, which no locale can reorder. */\nfunction codeUnitOrder(a: string, b: string): number {\n  return a < b ? -1 : a > b ? 1 : 0\n}\n\n/**\n * Registers a contributor. Idempotent per plugin and id: registering the same\n * pair again replaces the earlier contributor in place, so a declarations\n * module evaluated twice does not alert twice. A contributor with no plugin,\n * no id or no `evaluate` throws.\n */\nexport function registerUsageAlertContributor(\n  contributor: UsageAlertContributor,\n): void {\n  const pluginId = String(contributor.pluginId ?? '').trim()\n  const id = String(contributor.id ?? '').trim()\n  if (!pluginId || !id) {\n    throw new Error('a usage alert contributor needs a pluginId and an id')\n  }\n  if (typeof contributor.evaluate !== 'function') {\n    throw new Error(\n      `usage alert contributor \"${pluginId}:${id}\" has no evaluate function`,\n    )\n  }\n  const entry: UsageAlertContributor = {\n    pluginId,\n    id,\n    evaluate: contributor.evaluate,\n  }\n  const index = registrations.findIndex(\n    (existing) => existing.pluginId === pluginId && existing.id === id,\n  )\n  if (index >= 0) registrations[index] = entry\n  else registrations.push(entry)\n}\n\n/** Every registered contributor, in the order the sweep runs them. */\nexport function listUsageAlertContributors(): UsageAlertContributor[] {\n  return registrations\n    .map((entry, sequence) => ({ entry, sequence }))\n    .sort(\n      (a, b) =>\n        catalogRank(a.entry.pluginId) - catalogRank(b.entry.pluginId) ||\n        codeUnitOrder(a.entry.pluginId, b.entry.pluginId) ||\n        a.sequence - b.sequence,\n    )\n    .map(({ entry }) => ({ ...entry }))\n}\n\n/** Test seam: forget every contributor. */\nexport function resetUsageAlertContributorsForTests(): void {\n  registrations.length = 0\n}\n"],"names":["FIRST_PARTY_PLUGINS","registrations","CATALOG_ORDER","Map","map","plugin","index","id","catalogRank","pluginId","get","Number","MAX_SAFE_INTEGER","codeUnitOrder","a","b","registerUsageAlertContributor","contributor","String","trim","Error","evaluate","entry","findIndex","existing","push","listUsageAlertContributors","sequence","sort","resetUsageAlertContributorsForTests","length"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0CC;AAMD,SAASA,mBAAmB,QAAQ,uBAAmB;AAiDvD,MAAMC,gBAAyC,EAAE;AAEjD,MAAMC,gBAAgB,IAAIC,IACxBH,oBAAoBI,GAAG,CAAC,CAACC,QAAQC,QAAU;QAACD,OAAOE,EAAE;QAAED;KAAM;AAG/D,SAASE,YAAYC,QAAgB;QAC5BP;IAAP,QAAOA,qBAAAA,cAAcQ,GAAG,CAACD,qBAAlBP,qBAA+BS,OAAOC,gBAAgB;AAC/D;AAEA,kDAAkD,GAClD,SAASC,cAAcC,CAAS,EAAEC,CAAS;IACzC,OAAOD,IAAIC,IAAI,CAAC,IAAID,IAAIC,IAAI,IAAI;AAClC;AAEA;;;;;CAKC,GACD,OAAO,SAASC,8BACdC,WAAkC;QAEVA,uBACNA;IADlB,MAAMR,WAAWS,QAAOD,wBAAAA,YAAYR,QAAQ,YAApBQ,wBAAwB,IAAIE,IAAI;IACxD,MAAMZ,KAAKW,QAAOD,kBAAAA,YAAYV,EAAE,YAAdU,kBAAkB,IAAIE,IAAI;IAC5C,IAAI,CAACV,YAAY,CAACF,IAAI;QACpB,MAAM,IAAIa,MAAM;IAClB;IACA,IAAI,OAAOH,YAAYI,QAAQ,KAAK,YAAY;QAC9C,MAAM,IAAID,MACR,CAAC,yBAAyB,EAAEX,SAAS,CAAC,EAAEF,GAAG,0BAA0B,CAAC;IAE1E;IACA,MAAMe,QAA+B;QACnCb;QACAF;QACAc,UAAUJ,YAAYI,QAAQ;IAChC;IACA,MAAMf,QAAQL,cAAcsB,SAAS,CACnC,CAACC,WAAaA,SAASf,QAAQ,KAAKA,YAAYe,SAASjB,EAAE,KAAKA;IAElE,IAAID,SAAS,GAAGL,aAAa,CAACK,MAAM,GAAGgB;SAClCrB,cAAcwB,IAAI,CAACH;AAC1B;AAEA,oEAAoE,GACpE,OAAO,SAASI;IACd,OAAOzB,cACJG,GAAG,CAAC,CAACkB,OAAOK,WAAc,CAAA;YAAEL;YAAOK;QAAS,CAAA,GAC5CC,IAAI,CACH,CAACd,GAAGC,IACFP,YAAYM,EAAEQ,KAAK,CAACb,QAAQ,IAAID,YAAYO,EAAEO,KAAK,CAACb,QAAQ,KAC5DI,cAAcC,EAAEQ,KAAK,CAACb,QAAQ,EAAEM,EAAEO,KAAK,CAACb,QAAQ,KAChDK,EAAEa,QAAQ,GAAGZ,EAAEY,QAAQ,EAE1BvB,GAAG,CAAC,CAAC,EAAEkB,KAAK,EAAE,GAAM,aAAKA;AAC9B;AAEA,yCAAyC,GACzC,OAAO,SAASO;IACd5B,cAAc6B,MAAM,GAAG;AACzB"}

package/src/lib/types/ast.d.ts

@@ -0,0 +1,199 @@
+/**
+ * @license
+ * Copyright 2023 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 type { Literal as UnistLiteral, Node as UnistNode, Parent as UnistParent } from 'unist';
+export type { UnistNode as Node };
+/**
+ * This map registers all node types that may be used as top-level content in
+ * the document.
+ *
+ * These types are accepted inside `root` nodes.
+ *
+ * This interface can be augmented to register custom node types.
+ *
+ * @example
+ * declare module 'hast' {
+ *   interface RootContentMap {
+ *     // Allow using raw nodes defined by `rehype-raw`.
+ *     raw: Raw;
+ *   }
+ * }
+ */
+export interface RootContentMap {
+    comment: Comment;
+    doctype: DocType;
+    element: Element;
+    text: Text;
+}
+/**
+ * This map registers all node types that may be used as content in an element.
+ *
+ * These types are accepted inside `element` nodes.
+ *
+ * This interface can be augmented to register custom node types.
+ *
+ * @example
+ * declare module 'hast' {
+ *   interface RootContentMap {
+ *     custom: Custom;
+ *   }
+ * }
+ */
+export interface ElementContentMap {
+    comment: Comment;
+    element: Element;
+    text: Text;
+}
+export type Content = RootContent | ElementContent;
+export type RootContent = RootContentMap[keyof RootContentMap];
+export type ElementContent = ElementContentMap[keyof ElementContentMap];
+/**
+ * Node in hast containing other nodes.
+ */
+export interface Parent extends UnistParent {
+    /**
+     * List representing the children of a node.
+     */
+    children: Content[];
+}
+/**
+ * Nodes in hast containing a value.
+ */
+export interface Literal extends UnistLiteral {
+    value: string;
+}
+/**
+ * Root represents a document.
+ * Can be used as the rood of a tree, or as a value of the
+ * content field on a 'template' Element, never as a child.
+ */
+export interface Root extends Parent {
+    /**
+     * Represents this variant of a Node.
+     */
+    type: 'root';
+    /**
+     * List representing the children of a node.
+     */
+    children: RootContent[];
+}
+/**
+ * Element represents an HTML Element.
+ */
+export interface Element extends Parent {
+    /**
+     * Represents this variant of a Node.
+     */
+    type: 'element';
+    /**
+     * Represents the element’s local name.
+     */
+    tagName: string;
+    /**
+     * Represents information associated with the element.
+     */
+    properties?: Properties | undefined;
+    /**
+     * If the tagName field is 'template', a content field can be present.
+     */
+    content?: Root | undefined;
+    /**
+     * List representing the children of a node.
+     */
+    children: ElementContent[];
+}
+/**
+ * Represents information associated with an element.
+ */
+export interface Properties {
+    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number>;
+}
+/**
+ * Represents information associated with a dynamic element after js.
+ */
+export interface Props {
+    [PropertyName: string]: boolean | number | string | null | undefined | Array<string | number> | any;
+}
+/**
+ * Represents an HTML DocumentType.
+ */
+export interface DocType extends UnistNode {
+    /**
+     * Represents this variant of a Node.
+     */
+    type: 'doctype';
+    name: string;
+}
+/**
+ * Represents an HTML Comment.
+ */
+export interface Comment extends Literal {
+    /**
+     * Represents this variant of a Literal.
+     */
+    type: 'comment';
+}
+/**
+ * Represents an HTML Text.
+ */
+export interface Text extends Literal {
+    /**
+     * Represents this variant of a Literal.
+     */
+    type: 'text';
+}
+/**
+ * Nodes in hast containing a value of the taxonomy name displayed.
+ *
+ * `domain` kind is reserved for representing top-level vertical
+ * taxonomies. Examples would include things comparative to
+ * - `education`
+ * - `evolution`
+ * - `television`
+ *
+ * `category` kind is reserved for representing low-level vertical
+ * taxonomies. Examples would include things comparative to
+ * - `science`
+ * - `philosophy`
+ * - `biology`
+ *
+ * `tag` kind is reserved for representing high-level taxonomies, potentially
+ * shared across multiple categories and domains. Examples would include things
+ * comparative to
+ * - `healthy lifestyle`
+ * - `intimacy`
+ * - `2019 pandemic`
+ *
+ */
+export interface Taxonomy extends Literal {
+    /**
+     * Represents this variant of a Node.
+     */
+    type: 'taxonomy';
+    /**
+     * Represents the variant categorization of a Node.
+     */
+    kind: 'domain' | 'category' | 'tag';
+}
+/**
+ * Taxonomic represents any node that may be categorized/classified
+ */
+export interface Taxonomic {
+    /**
+     * Represents the additional property to declare taxonomies
+     */
+    taxonomies?: Taxonomy[] | undefined;
+}

package/src/lib/types/ast.js

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2023 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.
+ */ /**
+ * Taxonomic represents any node that may be categorized/classified
+ */ export { };
+
+//# sourceMappingURL=ast.js.map

package/src/lib/types/ast.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/aglyn/src/lib/types/ast.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2023 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 {\n  Literal as UnistLiteral,\n  Node as UnistNode,\n  Parent as UnistParent,\n} from 'unist'\n\nexport type { UnistNode as Node }\n\n/**\n * This map registers all node types that may be used as top-level content in\n * the document.\n *\n * These types are accepted inside `root` nodes.\n *\n * This interface can be augmented to register custom node types.\n *\n * @example\n * declare module 'hast' {\n *   interface RootContentMap {\n *     // Allow using raw nodes defined by `rehype-raw`.\n *     raw: Raw;\n *   }\n * }\n */\nexport interface RootContentMap {\n  comment: Comment\n  doctype: DocType\n  element: Element\n  text: Text\n}\n\n/**\n * This map registers all node types that may be used as content in an element.\n *\n * These types are accepted inside `element` nodes.\n *\n * This interface can be augmented to register custom node types.\n *\n * @example\n * declare module 'hast' {\n *   interface RootContentMap {\n *     custom: Custom;\n *   }\n * }\n */\nexport interface ElementContentMap {\n  comment: Comment\n  element: Element\n  text: Text\n}\n\nexport type Content = RootContent | ElementContent\nexport type RootContent = RootContentMap[keyof RootContentMap]\nexport type ElementContent = ElementContentMap[keyof ElementContentMap]\n\n/**\n * Node in hast containing other nodes.\n */\nexport interface Parent extends UnistParent {\n  /**\n   * List representing the children of a node.\n   */\n  children: Content[]\n}\n\n/**\n * Nodes in hast containing a value.\n */\nexport interface Literal extends UnistLiteral {\n  value: string\n}\n\n/**\n * Root represents a document.\n * Can be used as the rood of a tree, or as a value of the\n * content field on a 'template' Element, never as a child.\n */\nexport interface Root extends Parent {\n  /**\n   * Represents this variant of a Node.\n   */\n  type: 'root'\n\n  /**\n   * List representing the children of a node.\n   */\n  children: RootContent[]\n}\n\n/**\n * Element represents an HTML Element.\n */\nexport interface Element extends Parent {\n  /**\n   * Represents this variant of a Node.\n   */\n  type: 'element'\n\n  /**\n   * Represents the element’s local name.\n   */\n  tagName: string\n\n  /**\n   * Represents information associated with the element.\n   */\n  properties?: Properties | undefined\n\n  /**\n   * If the tagName field is 'template', a content field can be present.\n   */\n  content?: Root | undefined\n\n  /**\n   * List representing the children of a node.\n   */\n  children: ElementContent[]\n}\n\n/**\n * Represents information associated with an element.\n */\nexport interface Properties {\n  // prettier-ignore\n  [PropertyName: string]:\n    | boolean\n    | number\n    | string\n    | null\n    | undefined\n    | Array<string | number>\n}\n\n/**\n * Represents information associated with a dynamic element after js.\n */\nexport interface Props {\n  // prettier-ignore\n  [PropertyName: string]:\n    | boolean\n    | number\n    | string\n    | null\n    | undefined\n    | Array<string | number>\n    | any\n}\n\n/**\n * Represents an HTML DocumentType.\n */\nexport interface DocType extends UnistNode {\n  /**\n   * Represents this variant of a Node.\n   */\n  type: 'doctype'\n\n  name: string\n}\n\n/**\n * Represents an HTML Comment.\n */\nexport interface Comment extends Literal {\n  /**\n   * Represents this variant of a Literal.\n   */\n  type: 'comment'\n}\n\n/**\n * Represents an HTML Text.\n */\nexport interface Text extends Literal {\n  /**\n   * Represents this variant of a Literal.\n   */\n  type: 'text'\n}\n\n/**\n * Nodes in hast containing a value of the taxonomy name displayed.\n *\n * `domain` kind is reserved for representing top-level vertical\n * taxonomies. Examples would include things comparative to\n * - `education`\n * - `evolution`\n * - `television`\n *\n * `category` kind is reserved for representing low-level vertical\n * taxonomies. Examples would include things comparative to\n * - `science`\n * - `philosophy`\n * - `biology`\n *\n * `tag` kind is reserved for representing high-level taxonomies, potentially\n * shared across multiple categories and domains. Examples would include things\n * comparative to\n * - `healthy lifestyle`\n * - `intimacy`\n * - `2019 pandemic`\n *\n */\nexport interface Taxonomy extends Literal {\n  /**\n   * Represents this variant of a Node.\n   */\n  type: 'taxonomy'\n\n  /**\n   * Represents the variant categorization of a Node.\n   */\n  kind: 'domain' | 'category' | 'tag'\n}\n\n/**\n * Taxonomic represents any node that may be categorized/classified\n */\nexport interface Taxonomic {\n  /**\n   * Represents the additional property to declare taxonomies\n   */\n  taxonomies?: Taxonomy[] | undefined\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAyND;;CAEC,GACD,WAKC"}

package/src/lib/types/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2023 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.
+ */
+export * from './ast';
+export * from './nodes';
+export * from './routing';
+export * from './screen';

package/src/lib/types/index.js

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2023 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.
+ */ export * from "./ast.js";
+export * from "./nodes.js";
+export * from "./routing.js";
+export * from "./screen.js";
+
+//# sourceMappingURL=index.js.map

package/src/lib/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/aglyn/src/lib/types/index.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2023 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\nexport * from './ast'\nexport * from './nodes'\nexport * from './routing'\nexport * from './screen'\n"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,cAAc,WAAO;AACrB,cAAc,aAAS;AACvB,cAAc,eAAW;AACzB,cAAc,cAAU"}