@sqlrooms/blocks 0.29.0-rc.6

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 SQLRooms Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# @sqlrooms/blocks
+
+Shared contracts and vocabulary for composable SQLRooms blocks.
+
+Blocks are reusable units of SQLRooms workspace state or behavior. A block can
+be small and local, like a text or chart block, or stateful, like a dashboard,
+pivot table, notebook, or app surface. This package defines the shared language
+for those block-shaped resources without owning their concrete runtime.
+
+This package intentionally contains no feature runtime, stores, or UI
+implementations. Feature packages own concrete block definitions:
+
+- `@sqlrooms/mosaic` owns dashboard/chart block implementations.
+- `@sqlrooms/pivot` owns pivot block implementations.
+- `@sqlrooms/documents` owns document and rich content block implementations.
+- Notebook/canvas/app packages own their own stateful block implementations.
+
+`@sqlrooms/blocks` provides the small shared contract layer that lets those
+implementations be hosted consistently in artifacts, documents, notebooks, or
+other block containers.
+
+## Concepts
+
+- `BlockInstance` identifies a block and stores portable block attributes.
+- `BlockReference` points at state managed elsewhere and records whether that
+  state is owned, shared, or external.
+- `StatefulBlockDefinition` describes how a feature package creates, ensures,
+  renames, deletes, closes, and renders its block state.
+- `OrderedBlockContainer` and `GraphBlockContainer` describe common container
+  shapes: linear documents and DAG-like notebooks.
+
+Concrete packages should keep their own state slices and renderers close to
+their domain. For example, dashboard blocks remain owned by `@sqlrooms/mosaic`,
+pivot blocks remain owned by `@sqlrooms/pivot`, and Markdown document blocks
+remain owned by `@sqlrooms/documents`.
+
+## Block Documents
+
+The first rich ordered block container in SQLRooms is
+[`BlockDocument`](../documents/README.md#block-documents) from
+`@sqlrooms/documents`.
+`BlockDocument` uses these shared contracts to host text, images, charts, and
+stateful blocks while keeping the editor/document runtime in the documents
+package.
+
+Use `@sqlrooms/blocks` when defining cross-package contracts for block-shaped
+resources. Use `@sqlrooms/documents` when you need the Tiptap-backed
+`BlockDocument` editor, persistence slice, commands, or AI authoring tools.

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Shared block contracts for SQLRooms packages.
+ *
+ * This package owns vocabulary and type shapes only. Concrete block
+ * implementations remain in the feature packages that own their state.
+ *
+ * @packageDocumentation
+ */
+import type { ComponentType } from 'react';
+export type BlockId = string;
+export type BlockType = string;
+export type BlockInstance<TAttrs extends Record<string, unknown> = Record<string, unknown>> = {
+    id: BlockId;
+    type: BlockType;
+    title?: string;
+    attrs?: TAttrs;
+};
+export type BlockCapability = 'stateful' | 'selectable' | 'embeddable' | 'executable' | 'participatesInDag' | 'producesRelation' | 'consumesRelation' | 'hasRuntimeCache';
+export type BlockCapabilities = Partial<Record<BlockCapability, true>>;
+export type BlockOwnership = 'owned' | 'shared' | 'external';
+export type BlockReference = {
+    blockInstanceId: BlockId;
+    blockType: BlockType;
+    ownership?: BlockOwnership;
+};
+export type OrderedBlockContainer = {
+    blockIds: BlockId[];
+};
+export type GraphBlockEdgeKind = 'dependency' | 'manual' | (string & {});
+export type GraphBlockEdge = {
+    id: string;
+    source: BlockId;
+    target: BlockId;
+    kind?: GraphBlockEdgeKind;
+};
+export type GraphBlockContainer = OrderedBlockContainer & {
+    edges: GraphBlockEdge[];
+};
+export type StatefulBlockContext<TRoomState = unknown> = {
+    blockId: BlockId;
+    blockType: BlockType;
+    title?: string;
+    attrs?: Record<string, unknown>;
+    getState: () => TRoomState;
+};
+export type StatefulBlockRenameContext<TRoomState = unknown> = StatefulBlockContext<TRoomState> & {
+    previousTitle: string;
+    title: string;
+};
+export type StatefulBlockRenderProps<TRoomState = unknown> = {
+    blockId: BlockId;
+    blockType: BlockType;
+    title?: string;
+    attrs?: Record<string, unknown>;
+    readOnly?: boolean;
+    getState?: () => TRoomState;
+};
+export type StatefulBlockDefinition<TRoomState = unknown> = {
+    type: BlockType;
+    label: string;
+    defaultTitle?: string;
+    icon?: ComponentType<{
+        className?: string;
+    }>;
+    capabilities?: BlockCapabilities;
+    createInstance?: (context: StatefulBlockContext<TRoomState>) => BlockInstance;
+    ensureState?: (context: StatefulBlockContext<TRoomState>) => void;
+    deleteState?: (context: StatefulBlockContext<TRoomState>) => void;
+    rename?: (context: StatefulBlockRenameContext<TRoomState>) => void;
+    close?: (context: StatefulBlockContext<TRoomState>) => void;
+    render: ComponentType<StatefulBlockRenderProps<TRoomState>>;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC;AAC7B,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC9D;IACF,EAAE,EAAE,OAAO,CAAC;IACZ,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,mBAAmB,GACnB,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,CAAC;AAEtB,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;AAEvE,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;AAE7D,MAAM,MAAM,cAAc,GAAG;IAC3B,eAAe,EAAE,OAAO,CAAC;IACzB,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,QAAQ,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEzE,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,GAAG;IACxD,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,UAAU,GAAG,OAAO,IAAI;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,QAAQ,EAAE,MAAM,UAAU,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,0BAA0B,CAAC,UAAU,GAAG,OAAO,IACzD,oBAAoB,CAAC,UAAU,CAAC,GAAG;IACjC,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEJ,MAAM,MAAM,wBAAwB,CAAC,UAAU,GAAG,OAAO,IAAI;IAC3D,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,UAAU,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,UAAU,GAAG,OAAO,IAAI;IAC1D,IAAI,EAAE,SAAS,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,aAAa,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IAC3C,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,cAAc,CAAC,EAAE,CACf,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,KACtC,aAAa,CAAC;IACnB,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC;IAClE,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC;IAClE,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,0BAA0B,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC;IACnE,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC;IAC5D,MAAM,EAAE,aAAa,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC,CAAC;CAC7D,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+/**
+ * Shared block contracts for SQLRooms packages.
+ *
+ * This package owns vocabulary and type shapes only. Concrete block
+ * implementations remain in the feature packages that own their state.
+ *
+ * @packageDocumentation
+ */
+export {};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG","sourcesContent":["/**\n * Shared block contracts for SQLRooms packages.\n *\n * This package owns vocabulary and type shapes only. Concrete block\n * implementations remain in the feature packages that own their state.\n *\n * @packageDocumentation\n */\n\nimport type {ComponentType} from 'react';\n\nexport type BlockId = string;\nexport type BlockType = string;\n\nexport type BlockInstance<\n  TAttrs extends Record<string, unknown> = Record<string, unknown>,\n> = {\n  id: BlockId;\n  type: BlockType;\n  title?: string;\n  attrs?: TAttrs;\n};\n\nexport type BlockCapability =\n  | 'stateful'\n  | 'selectable'\n  | 'embeddable'\n  | 'executable'\n  | 'participatesInDag'\n  | 'producesRelation'\n  | 'consumesRelation'\n  | 'hasRuntimeCache';\n\nexport type BlockCapabilities = Partial<Record<BlockCapability, true>>;\n\nexport type BlockOwnership = 'owned' | 'shared' | 'external';\n\nexport type BlockReference = {\n  blockInstanceId: BlockId;\n  blockType: BlockType;\n  ownership?: BlockOwnership;\n};\n\nexport type OrderedBlockContainer = {\n  blockIds: BlockId[];\n};\n\nexport type GraphBlockEdgeKind = 'dependency' | 'manual' | (string & {});\n\nexport type GraphBlockEdge = {\n  id: string;\n  source: BlockId;\n  target: BlockId;\n  kind?: GraphBlockEdgeKind;\n};\n\nexport type GraphBlockContainer = OrderedBlockContainer & {\n  edges: GraphBlockEdge[];\n};\n\nexport type StatefulBlockContext<TRoomState = unknown> = {\n  blockId: BlockId;\n  blockType: BlockType;\n  title?: string;\n  attrs?: Record<string, unknown>;\n  getState: () => TRoomState;\n};\n\nexport type StatefulBlockRenameContext<TRoomState = unknown> =\n  StatefulBlockContext<TRoomState> & {\n    previousTitle: string;\n    title: string;\n  };\n\nexport type StatefulBlockRenderProps<TRoomState = unknown> = {\n  blockId: BlockId;\n  blockType: BlockType;\n  title?: string;\n  attrs?: Record<string, unknown>;\n  readOnly?: boolean;\n  getState?: () => TRoomState;\n};\n\nexport type StatefulBlockDefinition<TRoomState = unknown> = {\n  type: BlockType;\n  label: string;\n  defaultTitle?: string;\n  icon?: ComponentType<{className?: string}>;\n  capabilities?: BlockCapabilities;\n  createInstance?: (\n    context: StatefulBlockContext<TRoomState>,\n  ) => BlockInstance;\n  ensureState?: (context: StatefulBlockContext<TRoomState>) => void;\n  deleteState?: (context: StatefulBlockContext<TRoomState>) => void;\n  rename?: (context: StatefulBlockRenameContext<TRoomState>) => void;\n  close?: (context: StatefulBlockContext<TRoomState>) => void;\n  render: ComponentType<StatefulBlockRenderProps<TRoomState>>;\n};\n"]}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@sqlrooms/blocks",
+  "version": "0.29.0-rc.6",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "license": "MIT",
+  "author": "SQLRooms Contributors",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/react": "*"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit",
+    "typedoc": "typedoc"
+  }
+}