@visulima/vis 1.0.0-alpha.2 → 1.0.0-alpha.21

package/dist/config/index.js

@@ -0,0 +1 @@
+import{h as s,l as f,V as o,y as e,c as n,a as l,j as C,G as g,e as d,r}from"../packem_chunks/config.js";import{definePlugin as T}from"../packem_shared/definePlugin-CWm4Dv_t.js";import{otelPlugin as t}from"../packem_shared/otelPlugin-CJR2T_lk.js";export{s as CONFIG_FILES,f as SECURITY_DEFAULTS,o as TASK_CONFIG_FILES,e as applyDefaults,n as defineConfig,T as definePlugin,l as defineTaskConfig,C as findVisConfigFile,g as findVisTaskConfigFile,d as loadVisConfig,r as loadVisTaskConfig,t as otelPlugin};

package/dist/generate/index.d.ts

@@ -0,0 +1,157 @@
+/**
+* Type definitions for the `vis generate` template runtime.
+*
+* The shape intentionally echoes Bingo's `Template` so a future Bingo
+* adapter (re-exporting `bingo` Templates through this runtime) is a
+* one-pager. Authors do not depend on Bingo to write a vis generator.
+*/
+type VariableType = "array" | "boolean" | "enum" | "number" | "string";
+/** Common variable fields (all types). */
+interface VariableBase {
+  /**
+  * Default value when the user accepts the prompt without typing.
+  * For `boolean` this is `true|false`; for `enum` it must match `values`.
+  */
+  default?: boolean | number | string | string[];
+  /** Hide from prompts; can still be set via CLI or `--defaults`. */
+  internal?: boolean;
+  /** Sort order in prompts (lower first). Defaults to declaration order. */
+  order?: number;
+  /** Override the prompt text. Defaults to the variable name. */
+  prompt?: string;
+  /** When true, the user must provide a non-empty value. */
+  required?: boolean;
+}
+type StringVariable = VariableBase & {
+  type: "string";
+};
+type NumberVariable = VariableBase & {
+  type: "number";
+};
+type BooleanVariable = VariableBase & {
+  default?: boolean;
+  type: "boolean";
+};
+type ArrayVariable = VariableBase & {
+  type: "array";
+};
+interface EnumVariable extends VariableBase {
+  /** Allow multiple selections (returns `string[]`). */
+  multiple?: boolean;
+  type: "enum";
+  /** Selectable values. */
+  values: string[];
+}
+type Variable = ArrayVariable | BooleanVariable | EnumVariable | NumberVariable | StringVariable;
+/** Map of variable name → spec, as authors declare them. */
+type VariableMap = Record<string, Variable>;
+/** Resolved option values passed to `produce()`. */
+type Options = Record<string, unknown>;
+/** A file in a Creation can be a string, a Buffer (binary asset), or a nested directory. */
+type CreationFile = Buffer | string;
+interface CreationDirectory {
+  [key: string]: CreationDirectory | CreationFile;
+}
+/**
+* Script entry produced by `produce()`.
+* - `string`: shell command, runs in the destination directory.
+* - `object`: shell commands with optional phase ordering.
+*/
+type Script = ScriptObject | string;
+interface ScriptObject {
+  /** Shell command(s) to run sequentially. */
+  commands: string[];
+  /**
+  * Phase ordering. Phases run in ascending order; scripts within
+  * the same phase are dispatched concurrently. Default: 0.
+  */
+  phase?: number;
+  /** Suppress command output. Default: false. */
+  silent?: boolean;
+}
+/** Object returned by a template's `produce()` function. */
+interface Creation {
+  /** Recursive directory tree. Keys with `/` are auto-split. */
+  files?: CreationDirectory;
+  /**
+  * Per-file metadata keyed by the *flattened* destination path
+  * (e.g. `src/foo.ts`). Optional — native templates usually omit
+  * this; the moon adapter populates it from per-file frontmatter
+  * so `force: true` survives the trip to the runner without
+  * changing the shape of `files`.
+  */
+  filesMeta?: Record<string, FileMeta>;
+  /** Shell scripts to run after files are written. */
+  scripts?: Script[];
+  /** User-facing tips printed after the run. */
+  suggestions?: string[];
+}
+interface FileMeta {
+  /**
+  * Overwrite an existing file at this path without prompting or
+  * consulting the global `--force` flag.
+  */
+  force?: boolean;
+}
+/** Context object passed to `produce()`. */
+interface TemplateContext {
+  /** Built-in variables: `dest_dir`, `dest_rel_dir`, `working_dir`, `workspace_root`. */
+  builtins: BuiltinVars;
+  /** Resolved option values (after prompts + CLI overrides + defaults). */
+  options: Options;
+}
+interface BuiltinVars {
+  /** Absolute destination directory. */
+  dest_dir: string;
+  /** Destination relative to the workspace root. */
+  dest_rel_dir: string;
+  /** Caller's current working directory. */
+  working_dir: string;
+  /** Absolute workspace root (from `findMonorepoRootSync`, fallback to `working_dir`). */
+  workspace_root: string;
+}
+/** Top-level "About" metadata for a template. */
+interface TemplateAbout {
+  /** One-line description. */
+  description: string;
+  /** Short identifier shown in `vis generate --list` and prompts. */
+  name: string;
+}
+/**
+* The author-facing template shape.
+* Both native (`.vis/templates/&lt;name>.ts`) and moon-adapter outputs
+* normalize to this.
+*/
+interface Template {
+  about: TemplateAbout;
+  /**
+  * Default destination directory (relative to workspace root unless
+  * absolute or starting with `./`). Honored when the user does not
+  * pass `--to`. Maps to moon's `template.yml` `destination`.
+  */
+  destination?: string;
+  /** Variable schema for prompts. */
+  options?: VariableMap;
+  /** Build the Creation given resolved options and built-in vars. */
+  produce: (context: TemplateContext) => Creation | Promise<Creation>;
+}
+/**
+* Discovery record: a Template plus where it came from.
+* Surfaced by `vis generate --list`.
+*/
+interface DiscoveredTemplate {
+  /** Lazy loader — invoke to materialize the Template. */
+  load: () => Promise<Template>;
+  /** Stable name used by `vis generate &lt;name>`. */
+  name: string;
+  /** Absolute path on disk (file for native, directory for moon). */
+  path: string;
+  /** Source classification — affects load + listing. */
+  source: "builtin" | "config" | "moon" | "native" | "remote";
+}
+/**
+* Identity helper for type inference. Authors get autocomplete + checks
+* without having to annotate the export.
+*/
+declare const createTemplate: (template: Template) => Template;
+export { type ArrayVariable, type BooleanVariable, type BuiltinVars, type Creation, type CreationDirectory, type CreationFile, type DiscoveredTemplate, type EnumVariable, type FileMeta, type NumberVariable, type Options, type Script, type ScriptObject, type StringVariable, type Template, type TemplateAbout, type TemplateContext, type Variable, type VariableMap, type VariableType, createTemplate };

package/dist/generate/index.js

@@ -0,0 +1 @@
+var t=Object.defineProperty;var r=(e,a)=>t(e,"name",{value:a,configurable:!0});var c=Object.defineProperty,l=r((e,a)=>c(e,"name",{value:a,configurable:!0}),"a");const o=l(e=>e,"createTemplate");export{o as createTemplate};