@motionscript/code 0.0.0-stage → 0.1.0-alpha.10

package/dist/node.d.ts

@@ -0,0 +1,287 @@
+import { type NodeOf, type NormalizedColor, type Color as _Color, type Node2D as _Node2D, type Node2DProps as _Node2DProps } from "@motionscript/sdk";
+import { type CodeDiffStrategy, type CodePhaseStrategy, type CodeRange, type CodeTheme, type DimTransition, type IdLine, type RowBand, type RowsTransition, type StructuralTransition } from "./engine.js";
+/**
+ * Which token became which across an edit, and when each part of it happens.
+ * Arguments of {@link defineCode}: a strategy is a function, which a prop would
+ * take for a binding, so it is part of the component's definition instead.
+ */
+export interface CodeStrategies {
+    /** Decides which token became which across an edit. Defaults to `defaultCodeDiff`. */
+    diffStrategy?: CodeDiffStrategy;
+    /** Decides when (in normalized transition time) each part of an edit happens. Defaults to `defaultCodePhases`. */
+    phaseStrategy?: CodePhaseStrategy;
+}
+/** `code` part-way through a `to({ code })`: the source it leaves, the one it lands on, and how far along it is, eased. */
+export interface CodeBlend {
+    readonly from: string;
+    readonly to: string;
+    readonly t: number;
+}
+/** What `code` holds: a source, or a {@link CodeBlend} while a `to({ code })` runs. */
+export type CodeSource = string | CodeBlend;
+/** A range argument: one range, several, or a chain that went through JSON as `{ list }`. */
+export type CodeTarget = CodeRange | Iterable<CodeRange> | {
+    readonly list: CodeRange[];
+};
+/** What a structure was tokenized with: the grammar, the theme and whether the grammar had landed. */
+export interface CodeTokenBasis {
+    readonly language: string;
+    readonly theme: CodeTheme;
+    readonly highlighted: boolean;
+}
+/** A listing a command left behind: its source, its tokens, and the basis they were made on. */
+export interface CodeListing {
+    readonly source: string;
+    readonly lines: IdLine[];
+    readonly basis: CodeTokenBasis;
+}
+export interface CodeEditFrame {
+    readonly transition: StructuralTransition;
+    readonly progress: number;
+}
+/** The dim `highlight` leaves: what stays bright, what the rest dims to, and the cross-fade in flight. */
+export interface CodeFocus {
+    readonly dim: number | null;
+    readonly ids: Set<number>;
+    readonly fade: DimTransition | null;
+}
+export interface CodeBanding {
+    readonly bands: RowBand[];
+    readonly fade: RowsTransition | null;
+}
+/**
+ * A `Code` whose edits are paired and timed by `strategies`. {@link Code} is
+ * the one with the defaults; a project wanting another hands its own to the
+ * engine in its place (the key is the same).
+ *
+ * A listing and nothing else: no paint slots, and no box behind the tokens. A
+ * listing set on a card is a `Code` inside a hugging `Rect`.
+ */
+export declare function defineCode(strategies?: CodeStrategies): import("@motionscript/sdk").Component<"code", import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, {
+    readonly append: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly prepend: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly insert: {
+        readonly position: import("@motionscript/sdk").Type<[number, number] | undefined, [number, number] | undefined, false>;
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly remove: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+    };
+    readonly replace: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly replacement: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly highlight: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly dim: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetHighlight: unknown;
+    readonly highlightRows: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly color: import("@motionscript/sdk").Type<_Color, NormalizedColor, false>;
+        readonly radius: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetRowHighlight: unknown;
+}, readonly [], _Node2D<_Node2DProps>, import("@motionscript/sdk").CallProps<import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, readonly [], import("@motionscript/sdk").BuiltNode<import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, {
+    readonly append: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly prepend: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly insert: {
+        readonly position: import("@motionscript/sdk").Type<[number, number] | undefined, [number, number] | undefined, false>;
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly remove: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+    };
+    readonly replace: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly replacement: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly highlight: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly dim: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetHighlight: unknown;
+    readonly highlightRows: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly color: import("@motionscript/sdk").Type<_Color, NormalizedColor, false>;
+        readonly radius: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetRowHighlight: unknown;
+}, _Node2D<_Node2DProps>>>>;
+/**
+ * A syntax-highlighted listing whose edits animate token by token: each edit
+ * is diffed against what is on screen, so a token that survives travels to
+ * its new column and only what changed fades.
+ */
+export declare const Code: import("@motionscript/sdk").Component<"code", import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, {
+    readonly append: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly prepend: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly insert: {
+        readonly position: import("@motionscript/sdk").Type<[number, number] | undefined, [number, number] | undefined, false>;
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly remove: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+    };
+    readonly replace: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly replacement: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly highlight: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly dim: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetHighlight: unknown;
+    readonly highlightRows: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly color: import("@motionscript/sdk").Type<_Color, NormalizedColor, false>;
+        readonly radius: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetRowHighlight: unknown;
+}, readonly [], _Node2D<_Node2DProps>, import("@motionscript/sdk").CallProps<import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, readonly [], import("@motionscript/sdk").BuiltNode<import("@motionscript/sdk").Merge<import("@motionscript/sdk").Box2DState, {
+    readonly code: import("@motionscript/sdk").Type<string, CodeSource, false>;
+    readonly language: "typescript";
+    readonly fontFamily: "Fira Mono";
+    /** A built-in or registered theme name (e.g. `'github-dark'`), or a `CodeHighlightStyle` object. */
+    readonly theme: import("@motionscript/sdk").Type<CodeTheme, CodeTheme, false>;
+    readonly fontSize: 16;
+    readonly lineHeight: 1.6;
+    readonly letterSpacing: 1.1;
+    readonly showLineNumbers: false;
+    readonly lineNumberGap: 2;
+    readonly listing: import("@motionscript/sdk").Type<CodeListing | null, CodeListing | null, true>;
+    readonly edit: import("@motionscript/sdk").Type<CodeEditFrame | null, CodeEditFrame | null, true>;
+    readonly focus: import("@motionscript/sdk").Type<CodeFocus, CodeFocus, true>;
+    readonly banding: import("@motionscript/sdk").Type<CodeBanding, CodeBanding, true>;
+}>, {
+    readonly append: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly prepend: {
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly insert: {
+        readonly position: import("@motionscript/sdk").Type<[number, number] | undefined, [number, number] | undefined, false>;
+        readonly code: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly remove: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+    };
+    readonly replace: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly replacement: import("@motionscript/sdk").Type<string, string, false>;
+    };
+    readonly highlight: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly dim: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetHighlight: unknown;
+    readonly highlightRows: {
+        readonly target: import("@motionscript/sdk").Type<CodeTarget | undefined, CodeTarget | undefined, false>;
+        readonly color: import("@motionscript/sdk").Type<_Color, NormalizedColor, false>;
+        readonly radius: import("@motionscript/sdk").Type<number, number, false>;
+    };
+    readonly resetRowHighlight: unknown;
+}, _Node2D<_Node2DProps>>>>;
+export type Code = NodeOf<typeof Code>;
+export type CodeProps = NonNullable<Parameters<typeof Code>[0]>;
+/** What a listing shows now: its source, its token rows, and the edit in flight, if any. */
+export declare function listingOf(code: Code): {
+    readonly source: string;
+    readonly lines: readonly IdLine[];
+    readonly edit: StructuralTransition | null;
+};
+/** Every range matching the literal `text` in `source`, in order and not overlapping. Multi-line matches are found too. */
+export declare function findAllRanges(source: CodeSource, text: string): CodeRange[];
+/** The `index`th range matching `text`, or `null`. */
+export declare function findRangeAt(source: CodeSource, text: string, index: number): CodeRange | null;
+/** The first range matching `text`, or `null`. */
+export declare function findFirstRange(source: CodeSource, text: string): CodeRange | null;
+//# sourceMappingURL=node.d.ts.map

package/dist/node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../src/node.ts"],"names":[],"mappings":"AAAA,OAAO,EASH,KAAK,MAAM,EACX,KAAK,eAAe,EAKpB,KAAK,KAAK,IAAI,MAAM,EACpB,KAAK,MAAM,IAAI,OAAO,EACtB,KAAK,WAAW,IAAI,YAAY,EACnC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAkBH,KAAK,gBAAgB,EAGrB,KAAK,iBAAiB,EACtB,KAAK,SAAS,EACd,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,MAAM,EACX,KAAK,OAAO,EACZ,KAAK,cAAc,EACnB,KAAK,oBAAoB,EAC5B,MAAM,UAAU,CAAC;AAMlB;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,sFAAsF;IACtF,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,kHAAkH;IAClH,aAAa,CAAC,EAAE,iBAAiB,CAAC;CACrC;AAED,2HAA2H;AAC3H,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,uFAAuF;AACvF,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;AAE5C,6FAA6F;AAC7F,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAA;CAAE,CAAC;AAE1F,sGAAsG;AACtG,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;CACjC;AAED,gGAAgG;AAChG,MAAM,WAAW,WAAW;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAC1C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC7B;AAED,0GAA0G;AAC1G,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,WAAW;IACxB,QAAQ,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;CACxC;AAgBD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,UAAU,GAAE,cAAmB;;;;IAe9C,oGAAoG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAApG,oGAAoG;;;;;;;;;;;;;;;IAApG,oGAAoG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4BAkH/G;AAED;;;;GAIG;AACH,eAAO,MAAM,IAAI;;;;IAzHL,oGAAoG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAApG,oGAAoG;;;;;;;;;;;;;;;IAApG,oGAAoG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAyHhF,CAAC;AACjC,MAAM,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,IAAI,CAAC,CAAC;AACvC,MAAM,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhE,4FAA4F;AAC5F,wBAAgB,SAAS,CAAC,IAAI,EAAE,IAAI,GAAG;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,IAAI,CAAA;CAAE,CAKhJ;AAED,2HAA2H;AAC3H,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,CAa3E;AAED,sDAAsD;AACtD,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7F;AAED,kDAAkD;AAClD,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAEjF"}