@antelopejs/interface-dms-builder 0.3.1 → 0.4.1

package/README.md

@@ -1,29 +1,29 @@
 <div align="center">
 
-# @antelopejs/interface-dms-builder
+# `@antelopejs/interface-dms-builder`
 
-<a href="https://www.npmjs.com/package/@antelopejs/interface-dms-builder"><img alt="npm" src="https://img.shields.io/npm/v/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000"></a>
-<a href="./LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000"></a>
-<a href="https://discord.gg/g4pFt6eXqu"><img alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000"></a>
-<a href="https://dms.antelopejs.com/docs/modules/builder/extending"><img alt="Documentation" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000"></a>
+<a href="https://www.npmjs.com/package/@antelopejs/interface-dms-builder"><img alt="npm" src="https://img.shields.io/npm/v/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000" data-illustration></a>
+<a href="./LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@antelopejs/interface-dms-builder?style=for-the-badge&labelColor=000000&color=000000" data-illustration></a>
+<a href="https://discord.gg/g4pFt6eXqu"><img alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" data-illustration></a>
+<a href="https://dms.antelopejs.com/docs/modules/builder/extending"><img alt="Documentation" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" data-illustration></a>
 
-The AntelopeJS interface to edit a DMS project's pages, blocks, resources and queries from code.
+The AntelopeJS interface that edits the pages, blocks, resources and queries of a DMS project from code.
 
 </div>
 
 ## What it does
 
-- Creates and edits pages, categories and their block trees: `CreatePage`, `AddBlock`, `ConfigureBlock`, `MoveBlock`, `SetPageBlocks`…
-- Generates resources (a `Table`, a `DataController` and a model) and edits their fields.
+- Creates and edits pages, categories and their block trees with operations such as `CreatePage`, `AddBlock`, `ConfigureBlock`, `MoveBlock` and `SetPageBlocks`.
+- Generates resources, each a `Table`, a `DataController` and a model, and edits their fields.
 - Compiles query templates into a model method and a page route, so a card gets a number without hand-written code.
 - Reports every block type and DataType the builder can write, with a schema for its options (`GetCatalog`).
-- Returns every mutation as an `OpResult`: the files changed on success, a typed error otherwise.
+- Returns every mutation as an `OpResult`. It holds the files changed on success, and a typed error otherwise.
 
-Every operation is an `InterfaceFunction` routed to [`@antelopejs/dms-builder`](https://www.npmjs.com/package/@antelopejs/dms-builder), which parses the project, applies the edit as an AST rewrite, and writes only if the project still typechecks.
+Every operation is an `InterfaceFunction` routed to [`@antelopejs/dms-builder`](https://www.npmjs.com/package/@antelopejs/dms-builder). That module parses the project, applies the edit as an AST rewrite, and writes only if the project still typechecks.
 
 ## Install
 
-Add the interface to the module that calls the builder:
+Add the interface to the module that calls the builder.
 
 ```bash
 pnpm add @antelopejs/interface-dms-builder
@@ -31,7 +31,7 @@ pnpm add @antelopejs/interface-dms-builder
 
 ## Quick start
 
-Create a page and put a KPI card on it:
+The following code creates a page and puts a KPI card on it.
 
 ```ts
 import { AddBlock, CreatePage } from "@antelopejs/interface-dms-builder";
@@ -65,17 +65,17 @@ The interface declares this peer dependency:
 
 | Package                      | Supported        | Tested with |
 | ---------------------------- | ---------------- | ----------- |
-| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | —           |
+| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.4.0`     |
 
 <!-- antelopejs-docs-compat:end -->
 
-The implementation runs in development only, unless its [`api.enabled`](https://dms.antelopejs.com/docs/modules/builder/configuration) option forces it.
+The `@antelopejs/dms-builder` module implements this interface. The `@antelopejs/interface-dms-builder` row in the compatibility block of the [module README](../dms-builder/README.md#compatibility) gives the interface range each module release implements. The implementation is not a peer dependency of the interface package. It runs in development only, unless its [`api.enabled`](https://dms.antelopejs.com/docs/modules/builder/configuration) option turns it on.
 
 ## Documentation
 
-- [Extending the builder](https://dms.antelopejs.com/docs/modules/builder/extending): the interface and the HTTP API
-- [Interface reference](./docs/1.introduction.md): the canonical contract, shipped with this package and published at [/docs/modules/builder/reference](https://dms.antelopejs.com/docs/modules/builder/reference)
-- [A chart without code](./docs/10.a-chart-without-code.md): the whole journey, from picking a measure to reopening the page
+- [Extending the builder](https://dms.antelopejs.com/docs/modules/builder/extending) covers the interface and the HTTP API.
+- [Interface reference](./docs/1.introduction.md) is the canonical contract. It ships with this package and is published at [/docs/modules/builder/reference](https://dms.antelopejs.com/docs/modules/builder/reference).
+- [A chart without code](./docs/10.a-chart-without-code.md) follows one chart from the choice of a measure to the reopened page.
 
 ## Contributing
 

package/dist/catalog.d.ts

@@ -1,3 +1,4 @@
+import type { ConfigObject } from "./values";
 export interface ImportRef {
     name: string;
     module?: string;
@@ -58,10 +59,9 @@ export interface OptionSchema {
     "x-dataType"?: boolean;
     "x-component"?: boolean;
     "x-controller"?: boolean;
-    [key: string]: unknown;
 }
 export type ConfigSchema = Record<string, OptionSchema>;
-export type ShapeSource = "inferred" | "annotated";
+export type ConfigOrigin = "inferred" | "annotated";
 export type BlockGroup = "layout" | "content" | "data" | "visualization" | (string & {});
 export interface BlockTypeDescriptor {
     type: string;
@@ -75,10 +75,10 @@ export interface BlockTypeDescriptor {
     slots?: SlotDescriptor[];
     dynamicSlots?: DynamicSlots;
     config: ConfigSchema;
-    defaults?: Record<string, unknown>;
+    defaults?: ConfigObject;
     childMeta?: ConfigSchema;
-    fixedOptions?: Record<string, unknown>;
-    shapeSource: ShapeSource;
+    fixedOptions?: ConfigObject;
+    configOrigin: ConfigOrigin;
     description?: string;
     controllerArg?: boolean;
     initialChildren?: BlockInitialChild[];
@@ -86,7 +86,7 @@ export interface BlockTypeDescriptor {
 export interface BlockInitialChild {
     id: string;
     type: string;
-    options: Record<string, unknown>;
+    options: ConfigObject;
 }
 export interface DataTypeDescriptor {
     id: string;
@@ -104,7 +104,7 @@ export interface DataSourceDescriptor {
     id: string;
     title: string;
     description?: string;
-    responseShape: string;
+    responseKind: string;
     path: string;
     method?: string;
     params?: ConfigSchema;

package/dist/drafts.d.ts

@@ -3,13 +3,14 @@ import type { AddQueryInput, QueryPreview } from "./queries";
 import type { ResourceRef } from "./resources";
 import type { MutationOpts, OpResult } from "./results";
 import type { EditablePageMeta } from "./structure";
+import type { ConfigObject } from "./values";
 export interface BlockDraft {
     name: string;
     type?: string;
-    config?: Record<string, unknown>;
+    config?: ConfigObject;
     lockedOptions?: Record<string, string>;
     slot?: string;
-    meta?: Record<string, unknown>;
+    meta?: ConfigObject;
     controller?: ResourceRef;
     children?: BlockDraft[];
     preserve?: boolean;
@@ -19,17 +20,17 @@ export interface PageDraft {
     blocks: BlockDraft[];
     queries?: AddQueryInput[];
 }
-export interface ComponentPreview {
+export type ComponentPreview = {
     componentName: string;
-    options?: Record<string, unknown>;
+    options?: ConfigObject;
     children?: ComponentPreviewChild[];
-}
-export interface ComponentPreviewChild {
+};
+export type ComponentPreviewChild = {
     id: string;
     slot?: string;
     component: ComponentPreview;
-    [key: string]: unknown;
-}
+    [key: string]: ConfigObject[string];
+};
 export interface PageLayoutPreview {
     components: Record<string, ComponentPreview>;
     degraded: BlockPath[];
@@ -41,6 +42,6 @@ export declare const PreviewLayout: (page: string, draft: PageDraft) => Promise<
 export declare const PreviewQuery: (request: QueryPreviewRequest) => Promise<OpResult<QueryPreview>>;
 export interface QueryPreviewRequest {
     query: AddQueryInput;
-    args?: Record<string, unknown>;
+    args?: ConfigObject;
     tenant?: string;
 }

package/dist/drafts.js.map

@@ -1 +1 @@
-{"version":3,"file":"drafts.js","sourceRoot":"","sources":["../src/drafts.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAwFlD,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAMd,CAAC;AAOO,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAEd,CAAC;AAUO,QAAA,YAAY,GACvB,IAAA,kCAAiB,GAEd,CAAC"}
+{"version":3,"file":"drafts.js","sourceRoot":"","sources":["../src/drafts.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAyFlD,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAMd,CAAC;AAOO,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAEd,CAAC;AAUO,QAAA,YAAY,GACvB,IAAA,kCAAiB,GAEd,CAAC"}

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export * from "./catalog";
 export * from "./compose";
 export * from "./drafts";
 export * from "./mapping";
+export * from "./operation-map";
 export * from "./operations";
 export * from "./project";
 export * from "./queries";

package/dist/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./catalog"), exports);
 __exportStar(require("./compose"), exports);
 __exportStar(require("./drafts"), exports);
 __exportStar(require("./mapping"), exports);
+__exportStar(require("./operation-map"), exports);
 __exportStar(require("./operations"), exports);
 __exportStar(require("./project"), exports);
 __exportStar(require("./queries"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,6CAA2B;AAC3B,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,4CAA0B;AAC1B,+CAA6B;AAC7B,4CAA0B;AAC1B,4CAA0B;AAC1B,8CAA4B;AAC5B,4CAA0B;AAC1B,8CAA4B;AAC5B,+CAA6B;AAC7B,2CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,6CAA2B;AAC3B,4CAA0B;AAC1B,4CAA0B;AAC1B,2CAAyB;AACzB,4CAA0B;AAC1B,kDAAgC;AAChC,+CAA6B;AAC7B,4CAA0B;AAC1B,4CAA0B;AAC1B,8CAA4B;AAC5B,4CAA0B;AAC1B,8CAA4B;AAC5B,+CAA6B;AAC7B,2CAAyB"}

package/dist/operation-map.d.ts

@@ -0,0 +1,67 @@
+export declare const Operations: {
+    AddBlock: (input: import("./operations").AddBlockInput, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<{
+        path: import("./addressing").BlockPath;
+    }>>;
+    AddField: (ref: string, field: import("./resources").FieldSpec, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<{
+        path: import("./resources").FieldPath;
+    }>>;
+    AddModule: (id: string, entry: import("./project").ModuleEntryInput, opts?: import("./project").ProjectConfigOpts | undefined) => Promise<import("./results").OpResult<import("./project").ProjectConfigResult>>;
+    AddQuery: (page: string, input: import("./queries").AddQueryInput, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<{
+        query: import("./queries").QueryRef;
+        route: string;
+    }>>;
+    AnalyseDatabase: (input: import("./analysis").AnalyseDatabaseInput) => Promise<import("./results").OpResult<import("./analysis").AnalysisState>>;
+    ComposePage: (input: import("./compose").ComposePageInput, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<import("./compose").ComposePageData>>;
+    ConfigureBlock: (path: string, patch: import("./values").ConfigObject, opts?: import("./operations").ConfigureBlockOpts | undefined) => Promise<import("./results").OpResult>;
+    ConfigureCategory: (ref: string, patch: Partial<import("./structure").EditableCategoryMeta>) => Promise<import("./results").OpResult>;
+    ConfigureField: (path: string, patch: Partial<import("./resources").FieldAspects>, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    ConfigureModule: (id: string, entry: import("./project").ModuleEntryInput, opts?: import("./project").ProjectConfigOpts | undefined) => Promise<import("./results").OpResult<import("./project").ProjectConfigResult>>;
+    ConfigurePage: (ref: string, patch: Partial<import("./structure").EditablePageMeta>, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<{
+        ref: import("./addressing").PageRef;
+        version: string;
+    }>>;
+    ConfigureProject: (steps: import("./project").ProjectConfigStep[], opts?: import("./project").ProjectConfigOpts | undefined) => Promise<import("./results").OpResult<import("./project").ProjectConfigResult>>;
+    ConfigureQuery: (query: string, patch: Partial<import("./queries").AddQueryInput>, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    ConfigureResource: (ref: string, patch: import("./resources").EditableResourceMeta, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    ConfigureTableView: (page: string, settings: import("./table-view").TableViewSettings, opts?: import("./table-view").ConfigureTableViewOpts | undefined) => Promise<import("./results").OpResult<{
+        path: import("./addressing").BlockPath;
+    }>>;
+    CreateCategory: (input: import("./operations").CreateCategoryInput) => Promise<import("./results").OpResult<{
+        ref: import("./addressing").CategoryRef;
+    }>>;
+    CreateLocalModule: (id: string, path: string, entry?: import("./project").ModuleEntryInput | undefined, opts?: import("./project").CreateLocalModuleOpts | undefined) => Promise<import("./results").OpResult<import("./project").ProjectConfigResult>>;
+    CreatePage: (input: import("./operations").CreatePageInput) => Promise<import("./results").OpResult<{
+        ref: import("./addressing").PageRef;
+        filepath: string;
+    }>>;
+    CreateResource: (input: import("./resources").CreateResourceInput) => Promise<import("./results").OpResult<{
+        ref: import("./resources").ResourceRef;
+        files: import("./resources").ResourceFiles;
+    }>>;
+    DeleteCategory: (ref: string) => Promise<import("./results").OpResult>;
+    DeletePage: (ref: string, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    DeleteResource: (ref: string, opts?: import("./resources").DeleteResourceOpts | undefined) => Promise<import("./results").OpResult>;
+    GetAnalysis: (id: string) => Promise<import("./results").OpResult<import("./analysis").AnalysisState>>;
+    GetCatalog: () => Promise<import("./catalog").BlockCatalog>;
+    GetMapping: (connection: string, module: string) => Promise<import("./results").OpResult<import("./analysis").MappedRelation[]>>;
+    GetPageStructure: (ref: string) => Promise<import("./results").OpResult<import("./structure").PageStructure>>;
+    GetResourceStructure: (ref: string) => Promise<import("./results").OpResult<import("./resources").ResourceStructure>>;
+    ListCategories: () => Promise<import("./structure").CategorySummary[]>;
+    ListDataSources: (response?: string | undefined) => Promise<import("./catalog").DataSourceDescriptor[]>;
+    ListPages: () => Promise<import("./structure").PageSummary[]>;
+    ListQueryTemplates: (resourceType?: string | undefined) => Promise<import("./queries").QueryTemplateDescriptor[]>;
+    ListResources: () => Promise<import("./resources").ResourceSummary[]>;
+    MapResources: (input: import("./mapping").MapResourcesInput) => Promise<import("./results").OpResult<import("./mapping").MapResourcesResult>>;
+    PreviewMapResources: (input: import("./mapping").MapResourcesInput) => Promise<import("./results").OpResult<import("./mapping").MapResourcesPreview>>;
+    MoveBlock: (path: string, dest: import("./operations").MoveDest, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    PreviewLayout: (page: string, draft: import("./drafts").PageDraft) => Promise<import("./results").OpResult<import("./drafts").PageLayoutPreview>>;
+    PreviewQuery: (request: import("./drafts").QueryPreviewRequest) => Promise<import("./results").OpResult<import("./queries").QueryPreview>>;
+    RefreshSourceIndex: (scope?: import("./operations").RefreshScope | undefined) => Promise<void>;
+    RemoveBlock: (path: string, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    RemoveField: (path: string, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    RemoveQuery: (query: string, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult>;
+    SetPageBlocks: (page: string, draft: import("./drafts").PageDraft, opts?: import("./results").MutationOpts | undefined) => Promise<import("./results").OpResult<{
+        version: string;
+    }>>;
+};
+export type OperationName = keyof typeof Operations;

package/dist/operation-map.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Operations = void 0;
+const analysis_1 = require("./analysis");
+const compose_1 = require("./compose");
+const drafts_1 = require("./drafts");
+const mapping_1 = require("./mapping");
+const operations_1 = require("./operations");
+const project_1 = require("./project");
+const queries_1 = require("./queries");
+const resources_1 = require("./resources");
+const table_view_1 = require("./table-view");
+exports.Operations = {
+    AddBlock: operations_1.AddBlock,
+    AddField: resources_1.AddField,
+    AddModule: project_1.AddModule,
+    AddQuery: queries_1.AddQuery,
+    AnalyseDatabase: analysis_1.AnalyseDatabase,
+    ComposePage: compose_1.ComposePage,
+    ConfigureBlock: operations_1.ConfigureBlock,
+    ConfigureCategory: operations_1.ConfigureCategory,
+    ConfigureField: resources_1.ConfigureField,
+    ConfigureModule: project_1.ConfigureModule,
+    ConfigurePage: operations_1.ConfigurePage,
+    ConfigureProject: project_1.ConfigureProject,
+    ConfigureQuery: queries_1.ConfigureQuery,
+    ConfigureResource: resources_1.ConfigureResource,
+    ConfigureTableView: table_view_1.ConfigureTableView,
+    CreateCategory: operations_1.CreateCategory,
+    CreateLocalModule: project_1.CreateLocalModule,
+    CreatePage: operations_1.CreatePage,
+    CreateResource: resources_1.CreateResource,
+    DeleteCategory: operations_1.DeleteCategory,
+    DeletePage: operations_1.DeletePage,
+    DeleteResource: resources_1.DeleteResource,
+    GetAnalysis: analysis_1.GetAnalysis,
+    GetCatalog: operations_1.GetCatalog,
+    GetMapping: analysis_1.GetMapping,
+    GetPageStructure: operations_1.GetPageStructure,
+    GetResourceStructure: resources_1.GetResourceStructure,
+    ListCategories: operations_1.ListCategories,
+    ListDataSources: operations_1.ListDataSources,
+    ListPages: operations_1.ListPages,
+    ListQueryTemplates: queries_1.ListQueryTemplates,
+    ListResources: resources_1.ListResources,
+    MapResources: mapping_1.MapResources,
+    PreviewMapResources: mapping_1.PreviewMapResources,
+    MoveBlock: operations_1.MoveBlock,
+    PreviewLayout: drafts_1.PreviewLayout,
+    PreviewQuery: drafts_1.PreviewQuery,
+    RefreshSourceIndex: operations_1.RefreshSourceIndex,
+    RemoveBlock: operations_1.RemoveBlock,
+    RemoveField: resources_1.RemoveField,
+    RemoveQuery: queries_1.RemoveQuery,
+    SetPageBlocks: drafts_1.SetPageBlocks,
+};
+//# sourceMappingURL=operation-map.js.map

package/dist/operation-map.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operation-map.js","sourceRoot":"","sources":["../src/operation-map.ts"],"names":[],"mappings":";;;AAAA,yCAAsE;AACtE,uCAAwC;AACxC,qCAAsE;AACtE,uCAA8D;AAC9D,6CAiBsB;AACtB,uCAKmB;AACnB,uCAKmB;AACnB,2CASqB;AACrB,6CAAkD;AASrC,QAAA,UAAU,GAAG;IACxB,QAAQ,EAAR,qBAAQ;IACR,QAAQ,EAAR,oBAAQ;IACR,SAAS,EAAT,mBAAS;IACT,QAAQ,EAAR,kBAAQ;IACR,eAAe,EAAf,0BAAe;IACf,WAAW,EAAX,qBAAW;IACX,cAAc,EAAd,2BAAc;IACd,iBAAiB,EAAjB,8BAAiB;IACjB,cAAc,EAAd,0BAAc;IACd,eAAe,EAAf,yBAAe;IACf,aAAa,EAAb,0BAAa;IACb,gBAAgB,EAAhB,0BAAgB;IAChB,cAAc,EAAd,wBAAc;IACd,iBAAiB,EAAjB,6BAAiB;IACjB,kBAAkB,EAAlB,+BAAkB;IAClB,cAAc,EAAd,2BAAc;IACd,iBAAiB,EAAjB,2BAAiB;IACjB,UAAU,EAAV,uBAAU;IACV,cAAc,EAAd,0BAAc;IACd,cAAc,EAAd,2BAAc;IACd,UAAU,EAAV,uBAAU;IACV,cAAc,EAAd,0BAAc;IACd,WAAW,EAAX,sBAAW;IACX,UAAU,EAAV,uBAAU;IACV,UAAU,EAAV,qBAAU;IACV,gBAAgB,EAAhB,6BAAgB;IAChB,oBAAoB,EAApB,gCAAoB;IACpB,cAAc,EAAd,2BAAc;IACd,eAAe,EAAf,4BAAe;IACf,SAAS,EAAT,sBAAS;IACT,kBAAkB,EAAlB,4BAAkB;IAClB,aAAa,EAAb,yBAAa;IACb,YAAY,EAAZ,sBAAY;IACZ,mBAAmB,EAAnB,6BAAmB;IACnB,SAAS,EAAT,sBAAS;IACT,aAAa,EAAb,sBAAa;IACb,YAAY,EAAZ,qBAAY;IACZ,kBAAkB,EAAlB,+BAAkB;IAClB,WAAW,EAAX,wBAAW;IACX,WAAW,EAAX,uBAAW;IACX,WAAW,EAAX,qBAAW;IACX,aAAa,EAAb,sBAAa;CACd,CAAC"}

package/dist/operations.d.ts

@@ -3,6 +3,7 @@ import type { BlockCatalog, DataSourceDescriptor } from "./catalog";
 import type { ResourceRef } from "./resources";
 import type { MutationOpts, OpResult } from "./results";
 import type { CategorySummary, EditableCategoryMeta, EditablePageMeta, PagePermission, PageStructure, PageSummary } from "./structure";
+import type { ConfigObject } from "./values";
 export interface RefreshScope {
     page?: PageRef;
 }
@@ -31,9 +32,9 @@ export interface AddBlockInput {
     slot?: string;
     index?: number;
     name: string;
-    meta?: Record<string, unknown>;
+    meta?: ConfigObject;
     type: string;
-    config: Record<string, unknown>;
+    config: ConfigObject;
     controller?: ResourceRef;
 }
 export interface MoveDest {
@@ -43,12 +44,12 @@ export interface MoveDest {
 }
 export interface ConfigureBlockOpts extends MutationOpts {
     replace?: boolean;
-    meta?: Record<string, unknown>;
+    meta?: ConfigObject;
 }
 export declare const ListPages: () => Promise<PageSummary[]>;
 export declare const ListCategories: () => Promise<CategorySummary[]>;
 export declare const GetCatalog: () => Promise<BlockCatalog>;
-export declare const ListDataSources: (responseShape?: string | undefined) => Promise<DataSourceDescriptor[]>;
+export declare const ListDataSources: (response?: string | undefined) => Promise<DataSourceDescriptor[]>;
 export declare const GetPageStructure: (ref: string) => Promise<OpResult<PageStructure>>;
 export declare const RefreshSourceIndex: (scope?: RefreshScope | undefined) => Promise<void>;
 export declare const CreatePage: (input: CreatePageInput) => Promise<OpResult<{
@@ -57,6 +58,7 @@ export declare const CreatePage: (input: CreatePageInput) => Promise<OpResult<{
 }>>;
 export declare const ConfigurePage: (ref: string, patch: Partial<EditablePageMeta>, opts?: MutationOpts | undefined) => Promise<OpResult<{
     ref: PageRef;
+    version: string;
 }>>;
 export declare const DeletePage: (ref: string, opts?: MutationOpts | undefined) => Promise<OpResult>;
 export declare const CreateCategory: (input: CreateCategoryInput) => Promise<OpResult<{
@@ -67,6 +69,6 @@ export declare const DeleteCategory: (ref: string) => Promise<OpResult>;
 export declare const AddBlock: (input: AddBlockInput, opts?: MutationOpts | undefined) => Promise<OpResult<{
     path: BlockPath;
 }>>;
-export declare const ConfigureBlock: (path: string, patch: Record<string, unknown>, opts?: ConfigureBlockOpts | undefined) => Promise<OpResult>;
+export declare const ConfigureBlock: (path: string, patch: ConfigObject, opts?: ConfigureBlockOpts | undefined) => Promise<OpResult>;
 export declare const MoveBlock: (path: string, dest: MoveDest, opts?: MutationOpts | undefined) => Promise<OpResult>;
 export declare const RemoveBlock: (path: string, opts?: MutationOpts | undefined) => Promise<OpResult>;

package/dist/operations.js.map

@@ -1 +1 @@
-{"version":3,"file":"operations.js","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAoGlD,QAAA,SAAS,GAAG,IAAA,kCAAiB,GAAgC,CAAC;AAC9D,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAAoC,CAAC;AAC3C,QAAA,UAAU,GAAG,IAAA,kCAAiB,GAA+B,CAAC;AAS9D,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAEd,CAAC;AACO,QAAA,gBAAgB,GAC3B,IAAA,kCAAiB,GAAsD,CAAC;AAM7D,QAAA,kBAAkB,GAC7B,IAAA,kCAAiB,GAA2C,CAAC;AAElD,QAAA,UAAU,GACrB,IAAA,kCAAiB,GAId,CAAC;AAOO,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAMd,CAAC;AACO,QAAA,UAAU,GACrB,IAAA,kCAAiB,GAA4D,CAAC;AAEnE,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAEd,CAAC;AACO,QAAA,iBAAiB,GAC5B,IAAA,kCAAiB,GAKd,CAAC;AACO,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAA2C,CAAC;AAElD,QAAA,QAAQ,GACnB,IAAA,kCAAiB,GAKd,CAAC;AACO,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAMd,CAAC;AACO,QAAA,SAAS,GACpB,IAAA,kCAAiB,GAEd,CAAC;AACO,QAAA,WAAW,GACtB,IAAA,kCAAiB,GAEd,CAAC"}
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../src/operations.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAqGlD,QAAA,SAAS,GAAG,IAAA,kCAAiB,GAAgC,CAAC;AAC9D,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAAoC,CAAC;AAC3C,QAAA,UAAU,GAAG,IAAA,kCAAiB,GAA+B,CAAC;AAS9D,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAA0D,CAAC;AACjE,QAAA,gBAAgB,GAC3B,IAAA,kCAAiB,GAAsD,CAAC;AAM7D,QAAA,kBAAkB,GAC7B,IAAA,kCAAiB,GAA2C,CAAC;AAElD,QAAA,UAAU,GACrB,IAAA,kCAAiB,GAId,CAAC;AAQO,QAAA,aAAa,GACxB,IAAA,kCAAiB,GAMd,CAAC;AACO,QAAA,UAAU,GACrB,IAAA,kCAAiB,GAA4D,CAAC;AAEnE,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAEd,CAAC;AACO,QAAA,iBAAiB,GAC5B,IAAA,kCAAiB,GAKd,CAAC;AACO,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAA2C,CAAC;AAElD,QAAA,QAAQ,GACnB,IAAA,kCAAiB,GAKd,CAAC;AACO,QAAA,cAAc,GACzB,IAAA,kCAAiB,GAMd,CAAC;AACO,QAAA,SAAS,GACpB,IAAA,kCAAiB,GAEd,CAAC;AACO,QAAA,WAAW,GACtB,IAAA,kCAAiB,GAEd,CAAC"}

package/dist/project.d.ts

@@ -1,12 +1,13 @@
 import type { OpResult } from "./results";
+import type { ConfigObject } from "./values";
 export interface ImportOverrideInput {
     interface: string;
     source?: string;
     id?: string;
 }
 export interface ModuleEntryInput {
-    source?: Record<string, unknown>;
-    config?: Record<string, unknown>;
+    source?: ConfigObject;
+    config?: ConfigObject;
     env?: Record<string, string>;
     importOverrides?: ImportOverrideInput[];
     exportPriority?: Record<string, number>;

package/dist/project.js.map

@@ -1 +1 @@
-{"version":3,"file":"project.js","sourceRoot":"","sources":["../src/project.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AA6GlD,QAAA,gBAAgB,GAC3B,IAAA,kCAAiB,GAKd,CAAC;AAGO,QAAA,SAAS,GACpB,IAAA,kCAAiB,GAMd,CAAC;AAGO,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAMd,CAAC;AAGO,QAAA,iBAAiB,GAC5B,IAAA,kCAAiB,GAOd,CAAC"}
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../src/project.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AA8GlD,QAAA,gBAAgB,GAC3B,IAAA,kCAAiB,GAKd,CAAC;AAGO,QAAA,SAAS,GACpB,IAAA,kCAAiB,GAMd,CAAC;AAGO,QAAA,eAAe,GAC1B,IAAA,kCAAiB,GAMd,CAAC;AAGO,QAAA,iBAAiB,GAC5B,IAAA,kCAAiB,GAOd,CAAC"}

package/dist/queries.d.ts

@@ -1,22 +1,23 @@
 import type { ConfigSchema } from "./catalog";
 import type { ResourceRef } from "./resources";
 import type { MutationOpts, OpResult } from "./results";
+import type { ConfigValue } from "./values";
 export type QueryRef = string;
 export type QueryOutputKind = "scalar" | "series";
-export type QueryResponseShape = "series" | "card" | "value" | "items";
+export type QueryArrangement = "series" | "card" | "value" | "items";
 export type FilterOp = "eq" | "ne" | "gt" | "ge" | "lt" | "le";
-export interface QueryParamBinding {
+export type QueryParamBinding = {
     $param: {
         name: string;
         in?: "query" | "param";
     };
-}
-export type QueryParamValue = unknown;
-export interface QueryFilter {
+};
+export type QueryParamValue = ConfigValue;
+export type QueryFilter = {
     field: string;
     op: FilterOp;
     value: QueryParamValue;
-}
+};
 export interface QueryTemplateDescriptor {
     id: string;
     resourceType: "database-table";
@@ -29,10 +30,10 @@ export interface QueryPoint {
     x: number | string;
     y: number;
 }
-export type QueryResponseBody = Record<string, unknown>;
+export type QueryResponseBody = object;
 export interface QueryPreview {
     output: QueryOutputKind;
-    response?: QueryResponseShape;
+    response?: QueryArrangement;
     body: QueryResponseBody;
     truncated: boolean;
 }
@@ -41,19 +42,19 @@ export interface AddQueryInput {
     resource: ResourceRef;
     template: string;
     params?: Record<string, QueryParamValue>;
-    response?: QueryResponseShape;
+    response?: QueryArrangement;
     compare?: boolean;
     endpoint?: string;
 }
 export interface QueryStructure {
     name: string;
-    response?: QueryResponseShape;
+    response?: QueryArrangement;
     endpoint: string;
     resource?: ResourceRef;
     modelMethod?: string;
     output?: QueryOutputKind;
     template?: string;
-    params?: Record<string, unknown>;
+    params?: Record<string, QueryParamValue>;
     routeParams?: {
         name: string;
         in: "query" | "param" | "header";

package/dist/resources.d.ts

@@ -1,6 +1,6 @@
 import type { CategoryRef, PageRef } from "./addressing";
 import type { MutationOpts, OpResult } from "./results";
-import type { DataTypeValue } from "./values";
+import type { ConfigObject, DataTypeValue } from "./values";
 export type ResourceRef = string;
 export type FieldPath = string;
 export interface ResourceFiles {
@@ -29,7 +29,7 @@ export interface FieldAspects {
         optional?: boolean;
         decorators?: string[];
     };
-    columnExtras?: Record<string, unknown>;
+    columnExtras?: ConfigObject;
 }
 export interface FieldSpec extends FieldAspects {
     name: string;
@@ -45,7 +45,7 @@ export interface CreateResourceInput {
     displayName?: string;
     schema?: string;
     fields: FieldSpec[];
-    seeds?: Record<string, unknown>[];
+    seeds?: ConfigObject[];
     location?: ResourceLocation;
     routes?: ResourceRoute[];
     module?: string;

package/dist/results.d.ts

@@ -4,15 +4,15 @@ export interface FileChange {
     kind: "create" | "modify" | "delete";
     diff: string;
 }
-export interface ValidationIssue {
+export type ValidationIssue = {
     pointer: string;
     message: string;
-}
-export interface TypecheckError {
+};
+export type TypecheckError = {
     file: string;
     line: number;
     message: string;
-}
+};
 export interface OpWarning {
     code: "query_opaque" | "query_kept" | "index_clamped" | "datatype_fallback" | "data_not_dropped" | "route_changed" | "data_kept" | "page_not_written" | "relation_missing" | "display_not_proposed" | "module_not_loaded" | "setting_dropped" | "relation_skipped" | "display_dropped" | "field_flag_set" | "label_changed";
     message: string;

package/dist/structure.d.ts

@@ -1,8 +1,9 @@
 import type { BlockPath, CategoryRef, PageRef } from "./addressing";
 import type { QueryStructure } from "./queries";
 import type { ResourceRef } from "./resources";
-export type PagePermission = Record<string, unknown>;
-export type PageLive = Record<string, unknown>;
+import type { ConfigObject } from "./values";
+export type PagePermission = ConfigObject;
+export type PageLive = ConfigObject;
 export interface PageMeta {
     ref: PageRef;
     id: string;
@@ -33,8 +34,8 @@ export interface BlockNode {
     editable: boolean;
     opaqueReason?: string;
     slot?: string;
-    meta?: Record<string, unknown>;
-    config?: Record<string, unknown>;
+    meta?: ConfigObject;
+    config?: ConfigObject;
     lockedOptions?: Record<string, string>;
     controller?: ResourceRef;
     children?: BlockNode[];

package/dist/values.d.ts

@@ -1,19 +1,23 @@
-export interface DataTypeValue {
-    $dataType: string;
-    config?: Record<string, unknown>;
+export type ConfigValue = string | number | boolean | null | undefined | ConfigValue[] | ConfigObject;
+export interface ConfigObject {
+    [key: string]: ConfigValue;
 }
-export interface ExprValue {
+export type DataTypeValue = {
+    $dataType: string;
+    config?: ConfigObject;
+};
+export type ExprValue = {
     $expr: string;
-}
-export interface RefValue {
+};
+export type RefValue = {
     $ref: {
         resource: string;
         as?: "dataApi" | "table" | "model";
     };
-}
-export interface BlockValue {
+};
+export type BlockValue = {
     $block: {
         type: string;
-        config?: Record<string, unknown>;
+        config?: ConfigObject;
     };
-}
+};