insights/products/notebooks/frontend/generated/api.zod.ts at main

mirror of https://github.com/hanzoai/insights.git synced 2026-10-30 16:15:31 +00:00

Files

T

zeekay d696a015aa fix(brand): one name for the script language, and a guard that keeps it

The rename runs on the way in and nothing checked it afterwards, so paths and
content drifted apart in three places, and each one broke something quietly.

The script language had three names at once.
Files on disk carried `.iql`/`.iqle`, the source matchers said `.script`, and
the bytecode matchers said `.hoge`, so the test harness globbed zero files and
the STL compiler regenerated an empty table.
It is `script` now, in one place: `.script` source, `.scriptc` bytecode,
`bin/script` to run one and `bin/scriptc` to compile one.

190 TypeScript specifiers named files that had been renamed away, which is the
whole CDP consumer graph -- the event worker, not the web boot.
`--check` only ever read Python imports; it reads both module systems now, and
repoints both.

`-hog-` became `-mascot-` in paths while content said `script`, so the code
review product's skill directories stopped matching the prefix that discovers
them and it ran with no perspectives at all.

PATH_REGEX is CONTENT_REGEX -- the same list, not a copy -- so a rule can no
longer land in one and miss the other, and the four disagreeing `hog` path
rules collapse into the one word rule content already had.

`HOGLI_*` becomes `INSIGHTSCLI_*` at every reader and writer, with no alias: an
env var read under two names is two names.
The seven casings of `hogql` and five of `hogvm` collapse into one rule per
prefix casing, which leaves the suffix alone because `QL` is SQL's and `VM` is
a virtual machine's.

`--check` now refuses every retired spelling, in content and in paths, and
draws the line the rules draw: `insights_hogfunction` is a Postgres table so it
is left alone, and a migration filename is its identity in `django_migrations`
so it is frozen rather than failed.
Third-party names we cannot rename are reported as pending, never exempted.

2026-08-08 18:38:11 -07:00

431 lines

21 KiB

TypeScript

Generated

Raw Permalink Blame History

 /**
  * Auto-generated Zod validation schemas from the Django backend OpenAPI schema.
  * To modify these schemas, update the Django serializers or views, then run:
  *   insightscli build:openapi
  * Questions or issues? #team-devex on Slack
  *
  * Insights API - generated
  * OpenAPI spec version: 1.0.0
  */
 import * as zod from 'zod'
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksCreateBodyTitleMax = 256
 export const notebooksCreateBodyVersionMin = -2147483648
 export const notebooksCreateBodyVersionMax = 2147483647
 export const NotebooksCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksCreateBodyVersionMin)
         .max(notebooksCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksUpdateBodyTitleMax = 256
 export const notebooksUpdateBodyVersionMin = -2147483648
 export const notebooksUpdateBodyVersionMax = 2147483647
 export const NotebooksUpdateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksUpdateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksUpdateBodyVersionMin)
         .max(notebooksUpdateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksPartialUpdateBodyTitleMax = 256
 export const notebooksPartialUpdateBodyVersionMin = -2147483648
 export const notebooksPartialUpdateBodyVersionMax = 2147483647
 export const NotebooksPartialUpdateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksPartialUpdateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksPartialUpdateBodyVersionMin)
         .max(notebooksPartialUpdateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksCollabMarkdownSaveCreateBodyTextContentDefault = ``
 export const notebooksCollabMarkdownSaveCreateBodyCursorOneHeadMin = 0
 export const notebooksCollabMarkdownSaveCreateBodyCursorOneNodeIndexMin = 0
 export const notebooksCollabMarkdownSaveCreateBodyCursorOneOffsetMin = 0
 export const notebooksCollabMarkdownSaveCreateBodyCursorOneListItemIndexMin = 0
 export const NotebooksCollabMarkdownSaveCreateBody = /* @__PURE__ */ zod.object({
     client_id: zod
         .string()
         .describe('Unique identifier for the client session, used to skip self-echo on the update stream.'),
     version: zod
         .number()
         .describe('The notebook version the submitted content is based on (optimistic concurrency baseline).'),
     content: zod
         .unknown()
         .describe('The full markdown notebook document: a ProseMirror doc wrapping a single markdown node.'),
     text_content: zod
         .string()
         .default(notebooksCollabMarkdownSaveCreateBodyTextContentDefault)
         .describe('Plain text for search indexing.'),
     title: zod.string().optional().describe('Updated notebook title.'),
     cursor: zod
         .object({
             head: zod
                 .number()
                 .min(notebooksCollabMarkdownSaveCreateBodyCursorOneHeadMin)
                 .optional()
                 .describe('ProseMirror selection head position (rich v1 notebooks).'),
             node_index: zod
                 .number()
                 .min(notebooksCollabMarkdownSaveCreateBodyCursorOneNodeIndexMin)
                 .optional()
                 .describe("Index of the caret's block node in the markdown notebook document (markdown notebooks)."),
             offset: zod
                 .number()
                 .min(notebooksCollabMarkdownSaveCreateBodyCursorOneOffsetMin)
                 .optional()
                 .describe('Caret offset in the plain text of the focused editable element, in UTF-16 code units.'),
             list_item_index: zod
                 .number()
                 .min(notebooksCollabMarkdownSaveCreateBodyCursorOneListItemIndexMin)
                 .optional()
                 .describe('Index of the focused list item when the caret is inside a list block.'),
         })
         .optional()
         .describe(
             "The author's caret in the saved markdown, broadcast with the update so other clients can move the author's remote caret together with the text change."
         ),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksCollabPresenceCreateBodyClientIdMax = 200
 export const notebooksCollabPresenceCreateBodyVersionMin = 0
 export const notebooksCollabPresenceCreateBodyCursorOneHeadMin = 0
 export const notebooksCollabPresenceCreateBodyCursorOneNodeIndexMin = 0
 export const notebooksCollabPresenceCreateBodyCursorOneOffsetMin = 0
 export const notebooksCollabPresenceCreateBodyCursorOneListItemIndexMin = 0
 export const NotebooksCollabPresenceCreateBody = /* @__PURE__ */ zod.object({
     client_id: zod
         .string()
         .max(notebooksCollabPresenceCreateBodyClientIdMax)
         .describe('Unique identifier for the client session, used to skip self-echo on the update stream.'),
     version: zod
         .number()
         .min(notebooksCollabPresenceCreateBodyVersionMin)
         .describe('The notebook version the cursor position is relative to.'),
     cursor: zod
         .object({
             head: zod
                 .number()
                 .min(notebooksCollabPresenceCreateBodyCursorOneHeadMin)
                 .optional()
                 .describe('ProseMirror selection head position (rich v1 notebooks).'),
             node_index: zod
                 .number()
                 .min(notebooksCollabPresenceCreateBodyCursorOneNodeIndexMin)
                 .optional()
                 .describe("Index of the caret's block node in the markdown notebook document (markdown notebooks)."),
             offset: zod
                 .number()
                 .min(notebooksCollabPresenceCreateBodyCursorOneOffsetMin)
                 .optional()
                 .describe('Caret offset in the plain text of the focused editable element, in UTF-16 code units.'),
             list_item_index: zod
                 .number()
                 .min(notebooksCollabPresenceCreateBodyCursorOneListItemIndexMin)
                 .optional()
                 .describe('Index of the focused list item when the caret is inside a list block.'),
         })
         .describe("The caller's caret position, broadcast to other clients on this notebook's collab stream."),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksCollabSaveCreateBodyTextContentDefault = ``
 export const NotebooksCollabSaveCreateBody = /* @__PURE__ */ zod.object({
     client_id: zod.string().describe('Unique identifier for the client session.'),
     version: zod.number().describe("The collab version the client's steps are based on."),
     steps: zod.array(zod.unknown()).describe('List of ProseMirror step JSON objects to apply.'),
     content: zod.unknown().describe('The resulting ProseMirror document after applying the steps locally.'),
     text_content: zod
         .string()
         .default(notebooksCollabSaveCreateBodyTextContentDefault)
         .describe('Plain text for search indexing.'),
     title: zod.string().optional().describe('Updated notebook title.'),
     cursor_head: zod.number().nullish().describe('ProseMirror cursor head position after applying steps.'),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksInsightsqlExecuteCreateBodyTitleMax = 256
 export const notebooksInsightsqlExecuteCreateBodyVersionMin = -2147483648
 export const notebooksInsightsqlExecuteCreateBodyVersionMax = 2147483647
 export const NotebooksInsightsqlExecuteCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksInsightsqlExecuteCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksInsightsqlExecuteCreateBodyVersionMin)
         .max(notebooksInsightsqlExecuteCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * Set the notebook's kernel compute configuration. Applies at sandbox provision time: a currently running kernel keeps its resources until restarted.
  */
 export const NotebooksKernelConfigCreateBody = /* @__PURE__ */ zod.object({
     cpu_cores: zod
         .number()
         .optional()
         .describe("CPU cores for the notebook's sandbox kernel; must be a supported option."),
     memory_gb: zod
         .number()
         .optional()
         .describe("Memory in GB for the notebook's sandbox kernel; must be a supported option."),
     idle_timeout_seconds: zod
         .number()
         .optional()
         .describe('Seconds of inactivity before the sandbox kernel shuts down.'),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksKernelExecuteCreateBodyTitleMax = 256
 export const notebooksKernelExecuteCreateBodyVersionMin = -2147483648
 export const notebooksKernelExecuteCreateBodyVersionMax = 2147483647
 export const NotebooksKernelExecuteCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksKernelExecuteCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksKernelExecuteCreateBodyVersionMin)
         .max(notebooksKernelExecuteCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksKernelExecuteStreamCreateBodyTitleMax = 256
 export const notebooksKernelExecuteStreamCreateBodyVersionMin = -2147483648
 export const notebooksKernelExecuteStreamCreateBodyVersionMax = 2147483647
 export const NotebooksKernelExecuteStreamCreateBody = /* @__PURE__ */ zod.object({
     title: zod
         .string()
         .max(notebooksKernelExecuteStreamCreateBodyTitleMax)
         .nullish()
         .describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksKernelExecuteStreamCreateBodyVersionMin)
         .max(notebooksKernelExecuteStreamCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksKernelRestartCreateBodyTitleMax = 256
 export const notebooksKernelRestartCreateBodyVersionMin = -2147483648
 export const notebooksKernelRestartCreateBodyVersionMax = 2147483647
 export const NotebooksKernelRestartCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksKernelRestartCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksKernelRestartCreateBodyVersionMin)
         .max(notebooksKernelRestartCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksKernelStartCreateBodyTitleMax = 256
 export const notebooksKernelStartCreateBodyVersionMin = -2147483648
 export const notebooksKernelStartCreateBodyVersionMax = 2147483647
 export const NotebooksKernelStartCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksKernelStartCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksKernelStartCreateBodyVersionMin)
         .max(notebooksKernelStartCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement.
  */
 export const notebooksKernelStopCreateBodyTitleMax = 256
 export const notebooksKernelStopCreateBodyVersionMin = -2147483648
 export const notebooksKernelStopCreateBodyVersionMax = 2147483647
 export const NotebooksKernelStopCreateBody = /* @__PURE__ */ zod.object({
     title: zod.string().max(notebooksKernelStopCreateBodyTitleMax).nullish().describe('Title of the notebook.'),
     content: zod.unknown().optional().describe('Notebook content as a ProseMirror JSON document structure.'),
     text_content: zod.string().nullish().describe('Plain text representation of the notebook content for search.'),
     version: zod
         .number()
         .min(notebooksKernelStopCreateBodyVersionMin)
         .max(notebooksKernelStopCreateBodyVersionMax)
         .optional()
         .describe(
             'Version number for optimistic concurrency control. Must match the current version when updating content.'
         ),
     deleted: zod.boolean().optional().describe('Whether the notebook has been soft-deleted.'),
     _create_in_folder: zod.string().optional(),
 })
 /**
  * Dispatch an asynchronous run of a notebook SQL or Python cell. Returns a run_id immediately; poll the run result endpoint until the status is terminal. Flag-gated (revamped-py-notebooks).
  */
 export const notebooksSqlV2RunCreateBodyNodeTypeDefault = `insightsql`
 export const notebooksSqlV2RunCreateBodyOutputNameDefault = ``
 export const notebooksSqlV2RunCreateBodyRefsKindDefault = `insightsql`
 export const notebooksSqlV2RunCreateBodySendRawQueryDefault = false
 export const NotebooksSqlV2RunCreateBody = /* @__PURE__ */ zod.object({
     node_id: zod.string().describe('ProseMirror node id of the SQLV2 node being run.'),
     node_type: zod
         .enum(['insightsql', 'python'])
         .describe('\* `insightsql` - insightsql\n\* `python` - python')
         .default(notebooksSqlV2RunCreateBodyNodeTypeDefault)
         .describe(
             "Execution kind. 'insightsql' is a SQL node — pushed to Datastore, or rerouted to the sandbox's DuckDB when it references a local frame; 'python' runs the code in the sandbox kernel, materializing referenced upstream nodes as pandas frames first.\n\n\* `insightsql` - insightsql\n\* `python` - python"
         ),
     code: zod
         .string()
         .describe("The node's source — SQL for a insightsql node, Python for a python node. Must not be blank."),
     output_name: zod
         .string()
         .default(notebooksSqlV2RunCreateBodyOutputNameDefault)
         .describe(
             'Kernel nodes only: the dataframe variable to bind the result to in the kernel namespace (a python node falls back to the last expression for its preview).'
         ),
     refs: zod
         .record(
             zod.string(),
             zod.object({
                 node_id: zod.string().describe('ProseMirror node id of the upstream node this name points at.'),
                 kind: zod
                     .enum(['insightsql', 'local'])
                     .describe('\* `insightsql` - insightsql\n\* `local` - local')
                     .default(notebooksSqlV2RunCreateBodyRefsKindDefault)
                     .describe(
                         "What the name resolves to: 'insightsql' is a SQL node's query definition (resolved to its last-run InsightsQL); 'local' is a dataframe a Python node bound in the kernel namespace.\n\n\* `insightsql` - insightsql\n\* `local` - local"
                     ),
             })
         )
         .optional()
         .describe(
             "Available upstream nodes, keyed by dataframe name. A SQL node inlines referenced insightsql refs as CTEs — unless it references a local ref, which reroutes the run to the sandbox's DuckDB; a python node materializes the insightsql refs its code reads as pandas frames."
         ),
     connection_id: zod
         .uuid()
         .nullish()
         .describe(
             "SQL nodes only: id of a direct-query-capable external data source to run against instead of Insights's Datastore. Omit to query Insights."
         ),
     send_raw_query: zod
         .boolean()
         .default(notebooksSqlV2RunCreateBodySendRawQueryDefault)
         .describe(
             'Send the code to the selected connection verbatim instead of compiling it from InsightsQL first. Ignored without connection_id, and incompatible with references to other cells.'
         ),
 })

431 lines 21 KiB TypeScript Generated Raw Permalink Blame History

431 lines

21 KiB

TypeScript

Generated

Raw Permalink Blame History