@dxos/plugin-illustrator 0.10.0

package/dist/types/src/types/types.d.ts

@@ -0,0 +1,45 @@
+import type * as Effect from 'effect/Effect';
+import type { ComponentType } from 'react';
+import type { Database, Obj, Type } from '@dxos/echo';
+import { type SketchBuilder } from '#model';
+import type * as Sketch from './Sketch';
+/**
+ * Contribution from a canvas renderer plugin (e.g. plugin-tldraw, plugin-excalidraw).
+ * Defines how a sketch variant is created, rendered, and how the scene DSL maps onto it.
+ */
+export type SketchVariant = {
+    /** Stable id, typically the canvas typename (e.g. 'org.dxos.type.canvas'). */
+    id: string;
+    /** Human-readable variant name (e.g. 'tldraw'). */
+    label: string;
+    /** Optional Phosphor icon name (e.g. 'ph--compass-tool--regular'). */
+    icon?: string;
+    /** ECHO Type entity of the canvas object referenced by `Sketch.canvas`. */
+    canvasType: Type.AnyObj;
+    /**
+     * Build an empty canvas object. May allocate ECHO objects, run effects, etc.
+     * Returned object is added to the database alongside the Sketch.
+     */
+    createCanvas: (input?: Record<string, any>) => Effect.Effect<Obj.Any, Error, Database.Service>;
+    /** Maps the scene DSL onto this variant's canvas records. */
+    builder: SketchBuilder;
+    /** Optional Card surface component for this variant. */
+    card?: ComponentType<SketchVariantSurfaceProps>;
+    /** Optional Article/Section/Slide surface component for this variant. */
+    article?: ComponentType<SketchVariantSurfaceProps>;
+};
+export type SketchVariantSurfaceProps = {
+    /** The base Sketch object (may be a snapshot from useObject/Surface). */
+    sketch: Obj.Snapshot<Sketch.Sketch> | Sketch.Sketch;
+    /** The resolved LIVE canvas object — variant store adapters need `Doc.createAccessor`. */
+    canvas: Obj.Unknown;
+    /** Surface role passed through from the host. */
+    role?: string;
+    /** Attendable id passed through from the host. */
+    attendableId?: string;
+    /** Card surfaces: whether the card is editable. */
+    editable?: boolean;
+    /** Section surfaces: whether the embed is extrinsically sized. */
+    extrinsic?: boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/src/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAC7C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE3C,OAAO,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAEtD,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,QAAQ,CAAC;AAE5C,OAAO,KAAK,KAAK,MAAM,MAAM,UAAU,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,8EAA8E;IAC9E,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC;IACxB;;;OAGG;IACH,YAAY,EAAE,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC/F,6DAA6D;IAC7D,OAAO,EAAE,aAAa,CAAC;IACvB,wDAAwD;IACxD,IAAI,CAAC,EAAE,aAAa,CAAC,yBAAyB,CAAC,CAAC;IAChD,yEAAyE;IACzE,OAAO,CAAC,EAAE,aAAa,CAAC,yBAAyB,CAAC,CAAC;CACpD,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,yEAAyE;IACzE,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,0FAA0F;IAC1F,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC;IACpB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kEAAkE;IAClE,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/dist/types/src/util/index.d.ts

@@ -0,0 +1,2 @@
+export * from './load-sketch';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/util/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/util/index.ts"],"names":[],"mappings":"AAIA,cAAc,eAAe,CAAC"}

package/dist/types/src/util/load-sketch.d.ts

@@ -0,0 +1,37 @@
+import * as Effect from 'effect/Effect';
+import { Capability } from '@dxos/app-framework';
+import { Database, Obj, type Ref, Type } from '@dxos/echo';
+import * as Sketch from '../types/Sketch';
+import { type SketchVariant } from '../types/types';
+export declare class SketchVariantMismatchError extends Error {
+    readonly sketchId: string;
+    readonly expectedTypename: string;
+    readonly actualTypename: string;
+    readonly _tag = "SketchVariantMismatchError";
+    constructor(sketchId: string, expectedTypename: string, actualTypename: string);
+}
+export declare class UnknownSketchVariantError extends Error {
+    readonly typename: string;
+    readonly _tag = "UnknownSketchVariantError";
+    constructor(typename: string);
+}
+/**
+ * Loads a Sketch from a Ref and resolves its canvas, asserting the canvas matches
+ * the expected type. Returns the typed pair.
+ *
+ * Use in operation handlers that declare `input.sketch: SketchRef<MyCanvas>`.
+ */
+export declare const loadSketch: <S extends Type.AnyObj>(ref: Ref.Ref<Sketch.Sketch>, canvasType: S) => Effect.Effect<{
+    sketch: Sketch.Sketch;
+    canvas: Type.InstanceType<S>;
+}, Error, Database.Service>;
+/**
+ * Loads a Sketch and resolves the variant provider matching its canvas typename.
+ * Used by the renderer-agnostic read/edit operations.
+ */
+export declare const resolveVariant: (ref: Ref.Ref<Sketch.Sketch>) => Effect.Effect<{
+    sketch: Sketch.Sketch;
+    canvas: Obj.Any;
+    variant: SketchVariant;
+}, Error, Database.Service | Capability.Service>;
+//# sourceMappingURL=load-sketch.d.ts.map

package/dist/types/src/util/load-sketch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"load-sketch.d.ts","sourceRoot":"","sources":["../../../../src/util/load-sketch.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAG3D,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,qBAAa,0BAA2B,SAAQ,KAAK;IAGjD,QAAQ,CAAC,QAAQ,EAAE,MAAM;IACzB,QAAQ,CAAC,gBAAgB,EAAE,MAAM;IACjC,QAAQ,CAAC,cAAc,EAAE,MAAM;IAJjC,QAAQ,CAAC,IAAI,gCAAgC;IAC7C,YACW,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,MAAM,EACxB,cAAc,EAAE,MAAM,EAGhC;CACF;AAED,qBAAa,yBAA0B,SAAQ,KAAK;IAEtC,QAAQ,CAAC,QAAQ,EAAE,MAAM;IADrC,QAAQ,CAAC,IAAI,+BAA+B;IAC5C,YAAqB,QAAQ,EAAE,MAAM,EAEpC;CACF;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,IAAI,CAAC,MAAM,OACzC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,cACf,CAAC,KACZ,MAAM,CAAC,MAAM,CAAC;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;CAAE,EAAE,KAAK,EAAE,QAAQ,CAAC,OAAO,CAU7F,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,cAAc,QACpB,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,KAC1B,MAAM,CAAC,MAAM,CACd;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;IAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC;IAAC,OAAO,EAAE,aAAa,CAAA;CAAE,EAClE,KAAK,EACL,QAAQ,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAYnC,CAAC"}