@sixb/core 0.1.21 → 0.1.22

package/dist/artifacts/formula/parser.d.ts

@@ -0,0 +1,67 @@
+/**
+ * A computed column's formula, as an Excel table writes one: `([@Revenue]-[@Cost])/[@Revenue]`.
+ * `[@Name]` is this row's value in a column, `[Name]` the whole column (only inside an aggregate),
+ * and a name holding brackets or other special characters is bracketed again: `[@[Lead (weeks)]]`.
+ * In a name, `'` escapes the next character, as in Excel.
+ */
+export type FormulaNode = {
+    readonly kind: "number";
+    readonly value: number;
+} | {
+    readonly kind: "text";
+    readonly value: string;
+} | {
+    readonly kind: "boolean";
+    readonly value: boolean;
+}
+/** This row's value in a column. */
+ | {
+    readonly kind: "ref";
+    readonly column: string;
+}
+/** Every value of a column. */
+ | {
+    readonly kind: "columnRef";
+    readonly column: string;
+} | {
+    readonly kind: "unary";
+    readonly op: "-" | "+";
+    readonly operand: FormulaNode;
+} | {
+    readonly kind: "binary";
+    readonly op: FormulaOperator;
+    readonly left: FormulaNode;
+    readonly right: FormulaNode;
+} | {
+    readonly kind: "call";
+    readonly name: string;
+    readonly args: readonly FormulaNode[];
+};
+export type FormulaOperator = "+" | "-" | "*" | "/" | "^" | "&" | "=" | "<>" | "<" | "<=" | ">" | ">=";
+/** A formula that does not parse, with what is wrong where, from the first character as 1. */
+export declare class FormulaSyntaxError extends Error {
+    readonly position: number;
+    constructor(message: string, position: number);
+}
+/**
+ * Parses a formula, with or without its leading `=`. Throws a {@link FormulaSyntaxError} that
+ * says what is wrong and where.
+ */
+export declare function parseFormula(text: string): FormulaNode;
+/** The columns a formula reads, by row or whole. */
+export declare function formulaDependencies(node: FormulaNode): Set<string>;
+/**
+ * The columns a formula reads in its own row, `[@Revenue]`, apart from those it reads whole,
+ * `[Revenue]` in `SUM([Revenue])`: a value of the second depends on every row's.
+ */
+export declare function formulaReferences(node: FormulaNode): {
+    readonly row: Set<string>;
+    readonly whole: Set<string>;
+};
+/**
+ * A formula with every reference to a column renamed, `[@Revenue]` and `[Revenue]` alike, and
+ * nothing else changed: text in quotes is left as it is, and the new name is bracketed again when
+ * it holds characters a plain reference can't.
+ */
+export declare function renameColumnReferences(formula: string, from: string, to: string): string;
+//# sourceMappingURL=parser.d.ts.map

package/dist/artifacts/formula/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../../src/artifacts/formula/parser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GACnB;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE;AACvD,oCAAoC;GAClC;IAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE;AACnD,+BAA+B;GAC7B;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACvD;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,GAAG,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAA;CAAE,GACjF;IACE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,eAAe,CAAA;IAC5B,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAA;CAC5B,GACD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,WAAW,EAAE,CAAA;CAAE,CAAA;AAE3F,MAAM,MAAM,eAAe,GACvB,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,IAAI,GACJ,GAAG,GACH,IAAI,GACJ,GAAG,GACH,IAAI,CAAA;AAER,8FAA8F;AAC9F,qBAAa,kBAAmB,SAAQ,KAAK;IAGzC,QAAQ,CAAC,QAAQ,EAAE,MAAM;gBADzB,OAAO,EAAE,MAAM,EACN,QAAQ,EAAE,MAAM;CAK5B;AAmHD;;;GAGG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,CAsFtD;AAED,oDAAoD;AACpD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,WAAW,GAAG,GAAG,CAAC,MAAM,CAAC,CAIlE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,WAAW,GAAG;IACpD,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IACzB,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;CAC5B,CAOA;AA4BD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,CAyCxF"}

package/dist/artifacts/frames/assets.d.ts

@@ -1,28 +1,30 @@
 import type { ArtifactFrameTarget } from "../../storage/artifacts/types";
+import type { FrameLayout } from "./entries";
 /**
- * The files a frame gets besides the version's own, under `__sixb/`, which a version may not use.
- * The server serves them to the app's frames, and the Agent's layout check serves them to its
- * browser, so both lay a deck out the same way.
+ * The files a frame gets besides the version's own, under `__sixb/`, which a version may not use:
+ * a kit per layout, and the runtime. The server serves them to the app's frames, and the Agent's
+ * layout check serves them to its browser, so both lay a version out the same way.
  */
 export declare const FRAME_ASSETS: Readonly<Record<string, {
     readonly body: string;
     readonly type: string;
 }>>;
 /**
- * A deck's entry with the kit and the runtime first in its `<head>`, before anything of its own,
- * so the deck's styles and scripts build on them. Exactly once, whatever the markup: in `<head>`
+ * An entry with its layout's kit and the runtime first in its `<head>`, before anything of its
+ * own, so its styles and scripts build on them. Exactly once, whatever the markup: in `<head>`
  * when the page has one, else first in `<html>`, else right after the doctype, so a page without
  * either still renders in standards mode. Each element is looked for by parsing, not by matching
- * text, so a `<head>` inside a comment or a script's string is not one.
+ * text, so a `<head>` inside a comment or a script's string is not one. `entry` is where the page
+ * is in the version, so an entry in a folder, as a canvas's boards are, finds them.
  */
-export declare function injectFrameAssets(html: string): string;
+export declare function injectFrameAssets(html: string, layout: FrameLayout, entry?: string): string;
 /** Where a frame serves a file another artifact lends it: `__sixb/ref/<id>@<version>/<path>`. */
 export declare const FRAME_REFERENCE_PREFIX = "__sixb/ref/";
 /**
- * Points each image a deck shows from another artifact (`<img src="artifact:…">`) at the copy its
+ * Points each image an entry shows from another artifact (`<img src="artifact:…">`) at the copy its
  * frame serves, marked `data-sixb-ref`. An image its reader cannot see, or that the frame has
  * no target for, loses its source and is marked unavailable: the kit draws it as an empty box.
  * Addresses are compared as publishing recorded them, with their entities decoded.
  */
-export declare function rewriteFrameReferences(html: string, targets: readonly ArtifactFrameTarget[]): string;
+export declare function rewriteFrameReferences(html: string, targets: readonly ArtifactFrameTarget[], entry?: string): string;
 //# sourceMappingURL=assets.d.ts.map

package/dist/artifacts/frames/assets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AAOxE;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CACjC,MAAM,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAOjE,CAAA;AAID;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAgBtD;AAED,iGAAiG;AACjG,eAAO,MAAM,sBAAsB,gBAA8B,CAAA;AAUjE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,mBAAmB,EAAE,GACtC,MAAM,CAkBR"}
+{"version":3,"file":"assets.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/assets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AAIxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAI5C;;;;GAIG;AACH,eAAO,MAAM,YAAY,EAAE,QAAQ,CACjC,MAAM,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAQjE,CAAA;AAeD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,SAAe,GAAG,MAAM,CAiBjG;AAED,iGAAiG;AACjG,eAAO,MAAM,sBAAsB,gBAA8B,CAAA;AAUjE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,SAAS,mBAAmB,EAAE,EACvC,KAAK,SAAe,GACnB,MAAM,CAkBR"}

package/dist/artifacts/frames/entries.d.ts

@@ -0,0 +1,19 @@
+import type { ArtifactKind } from "../kinds";
+import type { ArtifactOutline } from "../outline";
+/**
+ * How the frame's runtime lays out what it serves: a deck shows 1280×720 slides scaled to fit, one
+ * at a time or all at once; a page scrolls like any web page, as a canvas's boards do.
+ */
+export type FrameLayout = "deck" | "page";
+/** A kind's frame layout, or null for a kind Sixb draws natively. */
+export declare function frameLayout(kind: ArtifactKind): FrameLayout | null;
+/**
+ * The files of a version its frame serves as pages, with the kit and the runtime first in their
+ * `<head>`: a deck's or a page's entry, or each of a canvas's boards; none for a kind that does
+ * not open in a frame.
+ */
+export declare function frameEntries(version: {
+    readonly entry: string;
+    readonly outline: ArtifactOutline;
+}): readonly string[];
+//# sourceMappingURL=entries.d.ts.map

package/dist/artifacts/frames/entries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entries.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/entries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAEjD;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,CAAA;AASzC,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,IAAI,EAAE,YAAY,GAAG,WAAW,GAAG,IAAI,CAElE;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE;IACpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;CAClC,GAAG,SAAS,MAAM,EAAE,CAKpB"}

package/dist/artifacts/frames/grants.d.ts

@@ -8,10 +8,10 @@ export interface ArtifactFrame {
 }
 type ReadArtifactVersion = (artifactId: string, version: number | "latest") => Promise<ArtifactVersionRecord | null>;
 /**
- * Issues a link that serves a deck's version to a sandboxed frame, with the files it embeds from
- * other artifacts that `read` finds. The token in the link is the credential: only its hash is
- * stored. Whoever asks must already have been allowed to read the version, and `read` reads as
- * them. Only a deck opens in a frame, since the frame serves its entry as a page.
+ * Issues a link that serves a version to a sandboxed frame, with the files it embeds from other
+ * artifacts that `read` finds. The token in the link is the credential: only its hash is stored.
+ * Whoever asks must already have been allowed to read the version, and `read` reads as them. Only
+ * a kind with a frame layout opens in one, since the frame serves its entry as a page.
  */
 export declare function createArtifactFrame(input: {
     readonly projectId: string;
@@ -21,8 +21,8 @@ export declare function createArtifactFrame(input: {
     readonly now?: Date;
 }): Promise<ArtifactFrame>;
 /**
- * What a frame link serves: its deck's version, and what it may show from other artifacts; `null`
- * once the link is unknown, expired, or its version gone, and for a version that is not a deck.
+ * What a frame link serves: its version, and what it may show from other artifacts; `null` once
+ * the link is unknown, expired, or its version gone, and for a kind that does not open in a frame.
  */
 export declare function resolveArtifactFrame(input: {
     readonly projectId: string;

package/dist/artifacts/frames/grants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/grants.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACtB,MAAM,+BAA+B,CAAA;AAItC,2EAA2E;AAC3E,eAAO,MAAM,2BAA2B,0BAA0B,CAAA;AAOlE,MAAM,WAAW,aAAa;IAC5B,+FAA+F;IAC/F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAA;CACzB;AAED,KAAK,mBAAmB,GAAG,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,QAAQ,KACvB,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;AAE1C;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE;IAC/C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAA;IACnC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAA;CACpB,GAAG,OAAO,CAAC,aAAa,CAAC,CAqBzB;AAiCD;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE;IAChD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAA;CACpB,GAAG,OAAO,CAAC;IACV,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;IACvC,QAAQ,CAAC,OAAO,EAAE,SAAS,mBAAmB,EAAE,CAAA;CACjD,GAAG,IAAI,CAAC,CAaR"}
+{"version":3,"file":"grants.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/grants.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACtB,MAAM,+BAA+B,CAAA;AAKtC,2EAA2E;AAC3E,eAAO,MAAM,2BAA2B,0BAA0B,CAAA;AAOlE,MAAM,WAAW,aAAa;IAC5B,+FAA+F;IAC/F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAA;CACzB;AAED,KAAK,mBAAmB,GAAG,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,MAAM,GAAG,QAAQ,KACvB,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAA;AAE1C;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,KAAK,EAAE;IAC/C,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;IACvC,QAAQ,CAAC,IAAI,CAAC,EAAE,mBAAmB,CAAA;IACnC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAA;CACpB,GAAG,OAAO,CAAC,aAAa,CAAC,CAqBzB;AAiCD;;;GAGG;AACH,wBAAsB,oBAAoB,CAAC,KAAK,EAAE;IAChD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAA;CACpB,GAAG,OAAO,CAAC;IACV,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;IACvC,QAAQ,CAAC,OAAO,EAAE,SAAS,mBAAmB,EAAE,CAAA;CACjD,GAAG,IAAI,CAAC,CAaR"}

package/dist/artifacts/frames/index.d.ts

@@ -1,9 +1,11 @@
 /**
  * Frames for this repo's packages: the server issues and serves them, with the kit and runtime,
- * and the Agent's layout check lays a deck out in them.
+ * and the Agent's layout check lays a version out in them.
  */
-export { SLIDES_ENTRY } from "../publish/validate/slides";
+export { HTML_ENTRY } from "../publish/validate/html";
+export { type SerializedArtifactQueryResult, serializeArtifactQueryResult, } from "../serialize-query";
 export { FRAME_ASSETS, FRAME_REFERENCE_PREFIX, injectFrameAssets, rewriteFrameReferences, } from "./assets";
+export { type FrameLayout, frameEntries, frameLayout } from "./entries";
 export { ARTIFACT_FRAME_ROUTE_PREFIX, createArtifactFrame, resolveArtifactFrame } from "./grants";
 export { FRAME_DEFAULT_THEMES } from "./kit";
 export { type LayoutProblem, layoutProbe } from "./probe";

package/dist/artifacts/frames/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,iBAAiB,EACjB,sBAAsB,GACvB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,KAAK,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/artifacts/frames/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAErD,OAAO,EACL,KAAK,6BAA6B,EAClC,4BAA4B,GAC7B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,iBAAiB,EACjB,sBAAsB,GACvB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,KAAK,WAAW,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvE,OAAO,EAAE,2BAA2B,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AACjG,OAAO,EAAE,oBAAoB,EAAE,MAAM,OAAO,CAAA;AAC5C,OAAO,EAAE,KAAK,aAAa,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA"}