@ibodr/schema 0.1.9 → 0.1.11

package/dist/index.d.ts

@@ -4661,6 +4661,28 @@ interface DrScribble {
  */
 declare const scribbleValidator: T.ObjectValidator<DrScribble>;
 
+/**
+ * The available visual background patterns that can be drawn behind the shapes
+ * on the canvas (e.g. a dotted grid, ruled notebook paper, etc).
+ *
+ * @public
+ */
+declare const DR_BOARD_BACKGROUND_TYPES: readonly ["none", "dots", "grid", "hex-grid", "lined", "double-line", "double-line-slash", "checkered"];
+/**
+ * The type of visual background pattern drawn behind the shapes on the canvas.
+ *
+ * - `none` - a plain, solid-colored background
+ * - `dots` - a dotted grid (matches the classic dot-grid look)
+ * - `grid` - a square line grid, like graph paper
+ * - `hex-grid` - a hexagonal grid
+ * - `lined` - horizontal ruled lines, like lined notebook paper
+ * - `double-line` - paired horizontal ruled lines, like handwriting practice paper
+ * - `double-line-slash` - paired horizontal ruled lines with slanted guide lines
+ * - `checkered` - a fine square grid, like squared notebook paper
+ *
+ * @public
+ */
+type DrBoardBackgroundType = (typeof DR_BOARD_BACKGROUND_TYPES)[number];
 /**
  * State that is particular to a single browser tab. The DrInstance record stores
  * all session-specific state including cursor position, selected tools, UI preferences,
@@ -4704,6 +4726,8 @@ interface DrInstance extends BaseRecord<'instance', DrInstanceId> {
     isChatting: boolean;
     isPenMode: boolean;
     isGridMode: boolean;
+    /** The visual background pattern drawn behind the shapes on the canvas. */
+    backgroundType: DrBoardBackgroundType;
     isFocused: boolean;
     devicePixelRatio: number;
     /**
@@ -6684,4 +6708,4 @@ declare class b64Vecs {
     static decodeLastPoint(b64Points: string): VecModel | null;
 }
 
-export { ArrowShapeArrowheadEndStyle, ArrowShapeArrowheadStartStyle, ArrowShapeKindStyle, AssetRecordType, type BoxModel, CameraRecordType, type CreatePresenceStateDerivationOpts, type CustomRecordInfo, DefaultColorStyle, DefaultDashStyle, DefaultFillStyle, DefaultFontFamilies, DefaultFontStyle, DefaultHorizontalAlignStyle, DefaultSizeStyle, DefaultTextAlignStyle, DefaultVerticalAlignStyle, DocumentRecordType, type DrArrowBinding, type DrArrowBindingProps, type DrArrowShape, type DrArrowShapeArrowheadStyle, type DrArrowShapeKind, type DrArrowShapeProps, type DrAsset, type DrAssetContext, type DrAssetId, type DrAssetPartial, type DrAssetShape, type DrAssetStore, type DrBaseAsset, type DrBaseBinding, type DrBaseShape, type DrBinding, type DrBindingCreate, type DrBindingId, type DrBindingUpdate, type DrBookmarkAsset, type DrBookmarkShape, type DrBookmarkShapeProps, type DrCamera, type DrCameraId, type DrCanvasUiColor, type DrCreateShapePartial, type DrCursor, type DrCursorType, type DrCustomRecord, DrDOCUMENT_ID, type DrDefaultAsset, type DrDefaultBinding, type DrDefaultColor, type DrDefaultColorStyle, type DrDefaultDashStyle, type DrDefaultFillStyle, type DrDefaultFontStyle, type DrDefaultHorizontalAlignStyle, type DrDefaultRecord, type DrDefaultShape, type DrDefaultSizeStyle, type DrDefaultTextAlignStyle, type DrDefaultVerticalAlignStyle, type DrDocument, type DrDrawShape, type DrDrawShapeProps, type DrDrawShapeSegment, type DrEmbedShape, type DrEmbedShapeProps, type DrFontFace, type DrFontFaceSource, type DrFrameShape, type DrFrameShapeProps, type DrGeoShape, type DrGeoShapeGeoStyle, type DrGeoShapeProps, type DrGlobalAssetPropsMap, type DrGlobalBindingPropsMap, type DrGlobalRecordPropsMap, type DrGlobalShapePropsMap, type DrGroupShape, type DrGroupShapeProps, type DrHandle, type DrHandleType, type DrHighlightShape, type DrHighlightShapeProps, DrINSTANCE_ID, type DrImageAsset, type DrImageShape, type DrImageShapeProps, type DrIndexedAssets, type DrIndexedBindings, type DrIndexedRecords, type DrIndexedShapes, type DrInstance, type DrInstanceId, type DrInstancePageState, type DrInstancePageStateId, type DrInstancePresence, type DrInstancePresenceID, type DrLanguage, type DrLineShape, type DrLineShapePoint, type DrLineShapeProps, type DrLineShapeSplineStyle, type DrNoteShape, type DrNoteShapeProps, type DrOpacityType, DrPOINTER_ID, type DrPage, type DrPageId, type DrParentId, type DrPointer, type DrPointerId, type DrPresenceStateInfo, type DrPropsMigration, type DrPropsMigrations, type DrRecord, type DrRemovedDefaultThemeColors, type DrRichText, type DrSchema, type DrScribble, type DrSerializedStore, type DrShape, type DrShapeCrop, type DrShapeId, type DrShapePartial, type DrStore, type DrStoreProps, type DrStoreSchema, type DrStoreSnapshot, type DrTextShape, type DrTextShapeProps, type DrTheme, type DrThemeColors, type DrThemeDefaultColors, type DrThemeFont, type DrThemeFonts, type DrThemeId, type DrThemeUiColorKeys, type DrThemes, type DrUnknownAsset, type DrUnknownBinding, type DrUnknownShape, type DrUser, type DrUserId, type DrUserStore, type DrVideoAsset, type DrVideoShape, type DrVideoShapeProps, ElbowArrowSnap, EnumStyleProp, type ExtractShapeByProps, GeoShapeGeoStyle, ImageShapeCrop, InstancePageStateRecordType, InstancePresenceRecordType, LANGUAGES, LineShapeSplineStyle, PageRecordType, PointerRecordType, type RecordProps, type RecordPropsType, type SchemaPropsInfo, type SetValue, type ShapeWithCrop, StyleProp, type StylePropValue, TL_CANVAS_UI_COLOR_TYPES, TL_CURSOR_TYPES, TL_HANDLE_TYPES, TL_SCRIBBLE_STATES, UserRecordType, type UserSchemaInfo, type VecModel, arrowBindingMigrations, arrowBindingProps, arrowBindingVersions, arrowShapeMigrations, arrowShapeProps, arrowShapeVersions, assetIdValidator, assetMigrations, b64Vecs, bindingIdValidator, bookmarkAssetMigrations, bookmarkAssetProps, bookmarkShapeMigrations, bookmarkShapeProps, boxModelValidator, canvasUiColorTypeValidator, compressLegacySegments, createAssetPropsMigrationIds, createAssetPropsMigrationSequence, createAssetRecordType, createAssetValidator, createBindingId, createBindingPropsMigrationIds, createBindingPropsMigrationSequence, createBindingValidator, createCachedUserResolve, createCustomRecordId, createCustomRecordMigrationIds, createCustomRecordMigrationSequence, createDrSchema, createPresenceStateDerivation, createShapeId, createShapePropsMigrationIds, createShapePropsMigrationSequence, createShapeValidator, createUserId, createUserRecordType, defaultAssetSchemas, defaultBindingSchemas, defaultShapeSchemas, drawShapeMigrations, drawShapeProps, embedShapeMigrations, embedShapeProps, frameShapeMigrations, frameShapeProps, geoShapeMigrations, geoShapeProps, getDefaultTranslationLocale, getDefaultUserPresence, getShapePropKeysByStyle, groupShapeMigrations, groupShapeProps, highlightShapeMigrations, highlightShapeProps, idValidator, imageAssetMigrations, imageAssetProps, imageShapeMigrations, imageShapeProps, isBinding, isBindingId, isCustomRecord, isCustomRecordId, isDocument, isFontEntry, isPageId, isShape, isShapeId, isUserId, lineShapeMigrations, lineShapeProps, noteShapeMigrations, noteShapeProps, opacityValidator, pageIdValidator, parentIdValidator, pluckPreservingValues, registerColorsFromThemes, registerFontsFromThemes, richTextValidator, rootBindingMigrations, rootShapeMigrations, scribbleValidator, shapeIdValidator, textShapeMigrations, textShapeProps, toRichText, userIdValidator, vecModelValidator, videoAssetMigrations, videoAssetProps, videoShapeMigrations, videoShapeProps };
+export { ArrowShapeArrowheadEndStyle, ArrowShapeArrowheadStartStyle, ArrowShapeKindStyle, AssetRecordType, type BoxModel, CameraRecordType, type CreatePresenceStateDerivationOpts, type CustomRecordInfo, DR_BOARD_BACKGROUND_TYPES, DefaultColorStyle, DefaultDashStyle, DefaultFillStyle, DefaultFontFamilies, DefaultFontStyle, DefaultHorizontalAlignStyle, DefaultSizeStyle, DefaultTextAlignStyle, DefaultVerticalAlignStyle, DocumentRecordType, type DrArrowBinding, type DrArrowBindingProps, type DrArrowShape, type DrArrowShapeArrowheadStyle, type DrArrowShapeKind, type DrArrowShapeProps, type DrAsset, type DrAssetContext, type DrAssetId, type DrAssetPartial, type DrAssetShape, type DrAssetStore, type DrBaseAsset, type DrBaseBinding, type DrBaseShape, type DrBinding, type DrBindingCreate, type DrBindingId, type DrBindingUpdate, type DrBoardBackgroundType, type DrBookmarkAsset, type DrBookmarkShape, type DrBookmarkShapeProps, type DrCamera, type DrCameraId, type DrCanvasUiColor, type DrCreateShapePartial, type DrCursor, type DrCursorType, type DrCustomRecord, DrDOCUMENT_ID, type DrDefaultAsset, type DrDefaultBinding, type DrDefaultColor, type DrDefaultColorStyle, type DrDefaultDashStyle, type DrDefaultFillStyle, type DrDefaultFontStyle, type DrDefaultHorizontalAlignStyle, type DrDefaultRecord, type DrDefaultShape, type DrDefaultSizeStyle, type DrDefaultTextAlignStyle, type DrDefaultVerticalAlignStyle, type DrDocument, type DrDrawShape, type DrDrawShapeProps, type DrDrawShapeSegment, type DrEmbedShape, type DrEmbedShapeProps, type DrFontFace, type DrFontFaceSource, type DrFrameShape, type DrFrameShapeProps, type DrGeoShape, type DrGeoShapeGeoStyle, type DrGeoShapeProps, type DrGlobalAssetPropsMap, type DrGlobalBindingPropsMap, type DrGlobalRecordPropsMap, type DrGlobalShapePropsMap, type DrGroupShape, type DrGroupShapeProps, type DrHandle, type DrHandleType, type DrHighlightShape, type DrHighlightShapeProps, DrINSTANCE_ID, type DrImageAsset, type DrImageShape, type DrImageShapeProps, type DrIndexedAssets, type DrIndexedBindings, type DrIndexedRecords, type DrIndexedShapes, type DrInstance, type DrInstanceId, type DrInstancePageState, type DrInstancePageStateId, type DrInstancePresence, type DrInstancePresenceID, type DrLanguage, type DrLineShape, type DrLineShapePoint, type DrLineShapeProps, type DrLineShapeSplineStyle, type DrNoteShape, type DrNoteShapeProps, type DrOpacityType, DrPOINTER_ID, type DrPage, type DrPageId, type DrParentId, type DrPointer, type DrPointerId, type DrPresenceStateInfo, type DrPropsMigration, type DrPropsMigrations, type DrRecord, type DrRemovedDefaultThemeColors, type DrRichText, type DrSchema, type DrScribble, type DrSerializedStore, type DrShape, type DrShapeCrop, type DrShapeId, type DrShapePartial, type DrStore, type DrStoreProps, type DrStoreSchema, type DrStoreSnapshot, type DrTextShape, type DrTextShapeProps, type DrTheme, type DrThemeColors, type DrThemeDefaultColors, type DrThemeFont, type DrThemeFonts, type DrThemeId, type DrThemeUiColorKeys, type DrThemes, type DrUnknownAsset, type DrUnknownBinding, type DrUnknownShape, type DrUser, type DrUserId, type DrUserStore, type DrVideoAsset, type DrVideoShape, type DrVideoShapeProps, ElbowArrowSnap, EnumStyleProp, type ExtractShapeByProps, GeoShapeGeoStyle, ImageShapeCrop, InstancePageStateRecordType, InstancePresenceRecordType, LANGUAGES, LineShapeSplineStyle, PageRecordType, PointerRecordType, type RecordProps, type RecordPropsType, type SchemaPropsInfo, type SetValue, type ShapeWithCrop, StyleProp, type StylePropValue, TL_CANVAS_UI_COLOR_TYPES, TL_CURSOR_TYPES, TL_HANDLE_TYPES, TL_SCRIBBLE_STATES, UserRecordType, type UserSchemaInfo, type VecModel, arrowBindingMigrations, arrowBindingProps, arrowBindingVersions, arrowShapeMigrations, arrowShapeProps, arrowShapeVersions, assetIdValidator, assetMigrations, b64Vecs, bindingIdValidator, bookmarkAssetMigrations, bookmarkAssetProps, bookmarkShapeMigrations, bookmarkShapeProps, boxModelValidator, canvasUiColorTypeValidator, compressLegacySegments, createAssetPropsMigrationIds, createAssetPropsMigrationSequence, createAssetRecordType, createAssetValidator, createBindingId, createBindingPropsMigrationIds, createBindingPropsMigrationSequence, createBindingValidator, createCachedUserResolve, createCustomRecordId, createCustomRecordMigrationIds, createCustomRecordMigrationSequence, createDrSchema, createPresenceStateDerivation, createShapeId, createShapePropsMigrationIds, createShapePropsMigrationSequence, createShapeValidator, createUserId, createUserRecordType, defaultAssetSchemas, defaultBindingSchemas, defaultShapeSchemas, drawShapeMigrations, drawShapeProps, embedShapeMigrations, embedShapeProps, frameShapeMigrations, frameShapeProps, geoShapeMigrations, geoShapeProps, getDefaultTranslationLocale, getDefaultUserPresence, getShapePropKeysByStyle, groupShapeMigrations, groupShapeProps, highlightShapeMigrations, highlightShapeProps, idValidator, imageAssetMigrations, imageAssetProps, imageShapeMigrations, imageShapeProps, isBinding, isBindingId, isCustomRecord, isCustomRecordId, isDocument, isFontEntry, isPageId, isShape, isShapeId, isUserId, lineShapeMigrations, lineShapeProps, noteShapeMigrations, noteShapeProps, opacityValidator, pageIdValidator, parentIdValidator, pluckPreservingValues, registerColorsFromThemes, registerFontsFromThemes, richTextValidator, rootBindingMigrations, rootShapeMigrations, scribbleValidator, shapeIdValidator, textShapeMigrations, textShapeProps, toRichText, userIdValidator, vecModelValidator, videoAssetMigrations, videoAssetProps, videoShapeMigrations, videoShapeProps };

package/dist/index.mjs

@@ -1146,6 +1146,16 @@ function isPageId(id) {
 }
 
 // src/records/DrInstance.ts
+var DR_BOARD_BACKGROUND_TYPES = [
+  "none",
+  "dots",
+  "grid",
+  "hex-grid",
+  "lined",
+  "double-line",
+  "double-line-slash",
+  "checkered"
+];
 var shouldKeyBePreservedBetweenSessions = {
   // This object defines keys that should be preserved across calls to loadSnapshot()
   id: false,
@@ -1190,6 +1200,8 @@ var shouldKeyBePreservedBetweenSessions = {
   // does not preserve because it's a temporary state
   isGridMode: true,
   // preserves because it's a user preference
+  backgroundType: true,
+  // preserves because it's a user preference
   isFocused: true,
   // preserves because obviously
   devicePixelRatio: true,
@@ -1243,6 +1255,7 @@ function createInstanceRecordType(stylesById) {
       zoomBrush: boxModelValidator.nullable(),
       isPenMode: T.boolean,
       isGridMode: T.boolean,
+      backgroundType: T.literalEnum(...DR_BOARD_BACKGROUND_TYPES),
       chatMessage: T.string,
       isChatting: T.boolean,
       highlightedUserIds: T.arrayOf(T.string),
@@ -1285,6 +1298,7 @@ function createInstanceRecordType(stylesById) {
       zoomBrush: true,
       isPenMode: true,
       isGridMode: true,
+      backgroundType: true,
       chatMessage: true,
       isChatting: true,
       highlightedUserIds: true,
@@ -1317,6 +1331,7 @@ function createInstanceRecordType(stylesById) {
       insets: [false, false, false, false],
       zoomBrush: null,
       isGridMode: false,
+      backgroundType: "none",
       isPenMode: false,
       chatMessage: "",
       isChatting: false,
@@ -1360,7 +1375,9 @@ var instanceVersions = createMigrationIds("com.draw.instance", {
   AddInset: 23,
   AddDuplicateProps: 24,
   RemoveCanMoveCamera: 25,
-  AddCameraState: 26
+  AddCameraState: 26,
+  AddBackgroundType: 27,
+  RemoveChalkboardBackground: 28
 });
 var instanceMigrations = createRecordMigrationSequence({
   sequenceId: "com.draw.instance",
@@ -1616,6 +1633,25 @@ var instanceMigrations = createRecordMigrationSequence({
       down: ({ cameraState: _, ...record }) => {
         return record;
       }
+    },
+    {
+      id: instanceVersions.AddBackgroundType,
+      up: (record) => {
+        return { ...record, backgroundType: "none" };
+      },
+      down: ({ backgroundType: _, ...record }) => {
+        return record;
+      }
+    },
+    {
+      id: instanceVersions.RemoveChalkboardBackground,
+      up: (record) => {
+        if (record.backgroundType === "chalkboard") {
+          return { ...record, backgroundType: "none" };
+        }
+        return record;
+      },
+      down: (record) => record
     }
   ]
 });
@@ -4075,10 +4111,10 @@ function getSupportedLocale(locale) {
 // src/index.ts
 registerDrawLibraryVersion(
   "@ibodr/schema",
-  "0.1.9",
+  "0.1.11",
   "esm"
 );
 
-export { ArrowShapeArrowheadEndStyle, ArrowShapeArrowheadStartStyle, ArrowShapeKindStyle, AssetRecordType, CameraRecordType, DefaultColorStyle, DefaultDashStyle, DefaultFillStyle, DefaultFontFamilies, DefaultFontStyle, DefaultHorizontalAlignStyle, DefaultSizeStyle, DefaultTextAlignStyle, DefaultVerticalAlignStyle, DocumentRecordType, DrDOCUMENT_ID, DrINSTANCE_ID, DrPOINTER_ID, ElbowArrowSnap, EnumStyleProp, GeoShapeGeoStyle, ImageShapeCrop, InstancePageStateRecordType, InstancePresenceRecordType, LANGUAGES, LineShapeSplineStyle, PageRecordType, PointerRecordType, StyleProp, TL_CANVAS_UI_COLOR_TYPES, TL_CURSOR_TYPES, TL_HANDLE_TYPES, TL_SCRIBBLE_STATES, UserRecordType, arrowBindingMigrations, arrowBindingProps, arrowBindingVersions, arrowShapeMigrations, arrowShapeProps, arrowShapeVersions, assetIdValidator, assetMigrations, b64Vecs, bindingIdValidator, bookmarkAssetMigrations, bookmarkAssetProps, bookmarkShapeMigrations, bookmarkShapeProps, boxModelValidator, canvasUiColorTypeValidator, compressLegacySegments, createAssetPropsMigrationIds, createAssetPropsMigrationSequence, createAssetRecordType, createAssetValidator, createBindingId, createBindingPropsMigrationIds, createBindingPropsMigrationSequence, createBindingValidator, createCachedUserResolve, createCustomRecordId, createCustomRecordMigrationIds, createCustomRecordMigrationSequence, createDrSchema, createPresenceStateDerivation, createShapeId, createShapePropsMigrationIds, createShapePropsMigrationSequence, createShapeValidator, createUserId, createUserRecordType, defaultAssetSchemas, defaultBindingSchemas, defaultShapeSchemas, drawShapeMigrations, drawShapeProps, embedShapeMigrations, embedShapeProps, frameShapeMigrations, frameShapeProps, geoShapeMigrations, geoShapeProps, getDefaultTranslationLocale, getDefaultUserPresence, getShapePropKeysByStyle, groupShapeMigrations, groupShapeProps, highlightShapeMigrations, highlightShapeProps, idValidator, imageAssetMigrations, imageAssetProps, imageShapeMigrations, imageShapeProps, isBinding, isBindingId, isCustomRecord, isCustomRecordId, isDocument, isFontEntry, isPageId, isShape, isShapeId, isUserId, lineShapeMigrations, lineShapeProps, noteShapeMigrations, noteShapeProps, opacityValidator, pageIdValidator, parentIdValidator, pluckPreservingValues, registerColorsFromThemes, registerFontsFromThemes, richTextValidator, rootBindingMigrations, rootShapeMigrations, scribbleValidator, shapeIdValidator, textShapeMigrations, textShapeProps, toRichText, userIdValidator, vecModelValidator, videoAssetMigrations, videoAssetProps, videoShapeMigrations, videoShapeProps };
+export { ArrowShapeArrowheadEndStyle, ArrowShapeArrowheadStartStyle, ArrowShapeKindStyle, AssetRecordType, CameraRecordType, DR_BOARD_BACKGROUND_TYPES, DefaultColorStyle, DefaultDashStyle, DefaultFillStyle, DefaultFontFamilies, DefaultFontStyle, DefaultHorizontalAlignStyle, DefaultSizeStyle, DefaultTextAlignStyle, DefaultVerticalAlignStyle, DocumentRecordType, DrDOCUMENT_ID, DrINSTANCE_ID, DrPOINTER_ID, ElbowArrowSnap, EnumStyleProp, GeoShapeGeoStyle, ImageShapeCrop, InstancePageStateRecordType, InstancePresenceRecordType, LANGUAGES, LineShapeSplineStyle, PageRecordType, PointerRecordType, StyleProp, TL_CANVAS_UI_COLOR_TYPES, TL_CURSOR_TYPES, TL_HANDLE_TYPES, TL_SCRIBBLE_STATES, UserRecordType, arrowBindingMigrations, arrowBindingProps, arrowBindingVersions, arrowShapeMigrations, arrowShapeProps, arrowShapeVersions, assetIdValidator, assetMigrations, b64Vecs, bindingIdValidator, bookmarkAssetMigrations, bookmarkAssetProps, bookmarkShapeMigrations, bookmarkShapeProps, boxModelValidator, canvasUiColorTypeValidator, compressLegacySegments, createAssetPropsMigrationIds, createAssetPropsMigrationSequence, createAssetRecordType, createAssetValidator, createBindingId, createBindingPropsMigrationIds, createBindingPropsMigrationSequence, createBindingValidator, createCachedUserResolve, createCustomRecordId, createCustomRecordMigrationIds, createCustomRecordMigrationSequence, createDrSchema, createPresenceStateDerivation, createShapeId, createShapePropsMigrationIds, createShapePropsMigrationSequence, createShapeValidator, createUserId, createUserRecordType, defaultAssetSchemas, defaultBindingSchemas, defaultShapeSchemas, drawShapeMigrations, drawShapeProps, embedShapeMigrations, embedShapeProps, frameShapeMigrations, frameShapeProps, geoShapeMigrations, geoShapeProps, getDefaultTranslationLocale, getDefaultUserPresence, getShapePropKeysByStyle, groupShapeMigrations, groupShapeProps, highlightShapeMigrations, highlightShapeProps, idValidator, imageAssetMigrations, imageAssetProps, imageShapeMigrations, imageShapeProps, isBinding, isBindingId, isCustomRecord, isCustomRecordId, isDocument, isFontEntry, isPageId, isShape, isShapeId, isUserId, lineShapeMigrations, lineShapeProps, noteShapeMigrations, noteShapeProps, opacityValidator, pageIdValidator, parentIdValidator, pluckPreservingValues, registerColorsFromThemes, registerFontsFromThemes, richTextValidator, rootBindingMigrations, rootShapeMigrations, scribbleValidator, shapeIdValidator, textShapeMigrations, textShapeProps, toRichText, userIdValidator, vecModelValidator, videoAssetMigrations, videoAssetProps, videoShapeMigrations, videoShapeProps };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map