@threekit-tools/treble 0.0.89 → 0.0.90-next-02

package/dist/hooks/useRoomBuilder/themes.js

@@ -0,0 +1,273 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IThemes = void 0;
+var IThemes;
+(function (IThemes) {
+    IThemes["DEFAULT"] = "default";
+    IThemes["BLUEPRINT"] = "blueprint";
+    IThemes["LIGHT"] = "light";
+})(IThemes = exports.IThemes || (exports.IThemes = {}));
+var HIGHLIGHT_COLOR = '#36738E';
+var ACTIVE_COLOR = 'green';
+var ERROR_COLOR = 'red';
+var DEFAULT_WALL_THICKNESS = 18;
+var DEFAULT_VERTEX_RADIUS = (DEFAULT_WALL_THICKNESS - 6) / 2;
+var DEFAULT_FEATURE_THICKNESS = DEFAULT_WALL_THICKNESS + 6;
+var defaultTheme = {
+    grid: {
+        gridStepGap: 12,
+        lineThickness: 1,
+        secondaryLineThickness: 2,
+        lineColor: '#ddd',
+        backgroundColor: '#fff',
+        secondaryLineIncrement: 4,
+    },
+    floor: {
+        color: '#eee',
+        textColor: '#666',
+    },
+    dimensions: {
+        padding: DEFAULT_WALL_THICKNESS / 2 + 12,
+        lineThickness: 1,
+        lineColor: '#444',
+        fontSize: 14,
+        font: 'Helvetica',
+        textColor: '#444',
+        textBackgroundColor: 'white',
+    },
+    wall: {
+        fill: '#d9d9d9',
+        stroke: '#d9d9d9',
+        strokeWidth: 0,
+        thickness: DEFAULT_WALL_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    vertex: {
+        innerFill: '#36738E',
+        outerFill: 'white',
+        stroke: '#36738E',
+        strokeWidth: 2,
+        outerRadius: DEFAULT_VERTEX_RADIUS,
+        innerRadius: DEFAULT_VERTEX_RADIUS / 2,
+        highlight: {
+            innerFill: HIGHLIGHT_COLOR,
+            outerFill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            innerFill: ACTIVE_COLOR,
+            outerFill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            innerFill: ERROR_COLOR,
+            outerFill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    feature: {
+        fill: '#888',
+        stroke: '#888',
+        strokeWidth: 0,
+        thickness: DEFAULT_FEATURE_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+};
+var BLUEPRINT_WALL_THICKNESS = 22;
+var BLUEPRINT_VERTEX_RADIUS = (BLUEPRINT_WALL_THICKNESS - 8) / 2;
+var BLUEPRINT_FEATURE_THICKNESS = BLUEPRINT_WALL_THICKNESS + 6;
+var blueprint = {
+    grid: {
+        gridStepGap: 20,
+        lineThickness: 1,
+        secondaryLineThickness: 2,
+        lineColor: '#fff',
+        backgroundColor: '#37588B',
+        secondaryLineIncrement: 3,
+    },
+    floor: {
+        color: '#eee',
+        textColor: '#666',
+    },
+    dimensions: {
+        padding: DEFAULT_WALL_THICKNESS / 2 + 12,
+        lineThickness: 1,
+        lineColor: '#fff',
+        fontSize: 14,
+        font: 'Helvetica',
+        textColor: '#444',
+        textBackgroundColor: '#fff',
+    },
+    wall: {
+        fill: '#848484',
+        stroke: '#fff',
+        strokeWidth: 1,
+        thickness: BLUEPRINT_WALL_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    vertex: {
+        innerFill: '#fff',
+        outerFill: '#fff',
+        stroke: '#36738E',
+        strokeWidth: 0,
+        outerRadius: BLUEPRINT_VERTEX_RADIUS,
+        innerRadius: BLUEPRINT_VERTEX_RADIUS / 2,
+        highlight: {
+            innerFill: HIGHLIGHT_COLOR,
+            outerFill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            innerFill: ACTIVE_COLOR,
+            outerFill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            innerFill: ERROR_COLOR,
+            outerFill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    feature: {
+        fill: '#888',
+        stroke: '#888',
+        strokeWidth: 0,
+        thickness: BLUEPRINT_FEATURE_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+};
+var LIGHT_WALL_THICKNESS = 8;
+var LIGHT_VERTEX_RADIUS = (LIGHT_WALL_THICKNESS + 8) / 2;
+var LIGHT_FEATURE_THICKNESS = LIGHT_WALL_THICKNESS + 4;
+var light = {
+    grid: {
+        gridStepGap: 15,
+        lineThickness: 1,
+        secondaryLineThickness: 2,
+        lineColor: '#ddd',
+        backgroundColor: '#fff',
+        secondaryLineIncrement: undefined,
+    },
+    floor: {
+        color: '#eee',
+        textColor: '#666',
+    },
+    dimensions: {
+        padding: DEFAULT_WALL_THICKNESS / 2 + 12,
+        lineThickness: 1,
+        lineColor: '#444',
+        fontSize: 14,
+        font: 'Helvetica',
+        textColor: '#444',
+        textBackgroundColor: '#fff',
+    },
+    wall: {
+        fill: '#000',
+        stroke: '#000',
+        strokeWidth: 0,
+        thickness: LIGHT_WALL_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    vertex: {
+        innerFill: '#aaa',
+        outerFill: '#fff',
+        stroke: '#000',
+        strokeWidth: 1,
+        outerRadius: LIGHT_VERTEX_RADIUS,
+        innerRadius: (LIGHT_VERTEX_RADIUS / 5) * 3,
+        highlight: {
+            innerFill: HIGHLIGHT_COLOR,
+            outerFill: '#fff',
+            stroke: '#000',
+        },
+        active: {
+            innerFill: ACTIVE_COLOR,
+            outerFill: '#fff',
+            stroke: '#000',
+        },
+        error: {
+            innerFill: ERROR_COLOR,
+            outerFill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+    feature: {
+        fill: '#888',
+        stroke: '#888',
+        strokeWidth: 0,
+        thickness: LIGHT_FEATURE_THICKNESS,
+        highlight: {
+            fill: HIGHLIGHT_COLOR,
+            stroke: HIGHLIGHT_COLOR,
+        },
+        active: {
+            fill: ACTIVE_COLOR,
+            stroke: ACTIVE_COLOR,
+        },
+        error: {
+            fill: ERROR_COLOR,
+            stroke: ERROR_COLOR,
+        },
+    },
+};
+exports.default = (_a = {},
+    _a[IThemes.DEFAULT] = defaultTheme,
+    _a[IThemes.BLUEPRINT] = blueprint,
+    _a[IThemes.LIGHT] = light,
+    _a);

package/dist/hooks/useRoomBuilder/types.d.ts

@@ -0,0 +1,247 @@
+export declare type ICoordinate2D = [x: number, y: number];
+export declare type ICoordinate3D = [x: number, y: number, z: number];
+export declare type ICoordinatesLine = [
+    startPoint: ICoordinate2D,
+    endPoint: ICoordinate2D
+];
+export declare type ICoordinatesQuadrilateral = [
+    point1: ICoordinate2D,
+    point2: ICoordinate2D,
+    point3: ICoordinate2D,
+    point4: ICoordinate2D
+];
+export declare enum IElements {
+    WALL = "walls",
+    VERTEX = "vertex",
+    FEATURE = "features",
+    WINDOW = "windows",
+    DOOR = "doors",
+    OPENING = "openings"
+}
+export declare type IFeatureName = IElements.WINDOW | IElements.DOOR | IElements.OPENING;
+export declare type IElementName = IElements.WALL | IElements.VERTEX | IFeatureName;
+export interface IWall {
+    assetId: string;
+    line: ICoordinatesLine;
+    path?: ICoordinatesQuadrilateral;
+    height?: number;
+    thickness?: number;
+    connections: Array<[elementType: IFeatureName, index: number]>;
+}
+export interface IWalls extends Array<IWall> {
+}
+export interface INewWall {
+    start: ICoordinate2D;
+    end?: ICoordinate2D;
+    snapStartTo?: ISnapPoint;
+    snapEndTo?: ISnapPoint;
+}
+export interface IVertexConnections extends Array<[wallIndex: number, anchorIndex: number]> {
+}
+export interface IVerticesState extends Record<string, IVertexConnections> {
+}
+export interface IVertex {
+    point: ICoordinate2D;
+    connections: IVertexConnections;
+}
+export interface ILineDimensions {
+    label: string;
+    line: ICoordinatesLine;
+}
+export interface IEnclosedSpace {
+    area: string;
+    center: ICoordinate2D;
+    loop: Array<ICoordinate2D>;
+}
+export interface IFeature {
+    assetId: string;
+    offset: number;
+    length: number;
+    path?: ICoordinatesQuadrilateral;
+    connectedTo: [elementType: IElements.WALL, index: number];
+}
+export interface IFeatureHydrated extends IFeature {
+    line: ICoordinatesLine;
+}
+export interface IFeaturesShared<T> {
+    [IElements.WINDOW]?: Array<T>;
+    [IElements.DOOR]?: Array<T>;
+    [IElements.OPENING]?: Array<T>;
+}
+export interface IFeatures extends IFeaturesShared<IFeature> {
+}
+export interface IFeaturesHydrated extends IFeaturesShared<IFeatureHydrated> {
+}
+export declare enum IElementStyleModes {
+    HIGHLIGHT = "highlight",
+    ACTIVE = "active",
+    ERROR = "error"
+}
+export interface IRoomBuilderStylesShared {
+    fill: string;
+    stroke?: string;
+    strokeWidth?: number;
+    [IElementStyleModes.HIGHLIGHT]: {
+        fill: string;
+        stroke: string;
+    };
+    [IElementStyleModes.ACTIVE]: {
+        fill: string;
+        stroke: string;
+    };
+    [IElementStyleModes.ERROR]: {
+        fill: string;
+        stroke: string;
+    };
+}
+export interface IStylesGrid {
+    gridStepGap: number;
+    lineThickness: number;
+    secondaryLineThickness: number;
+    lineColor: string;
+    backgroundColor?: string;
+    secondaryLineIncrement?: number;
+}
+export interface IStylesFloor {
+    color: string;
+    textColor: string;
+}
+export interface IStylesDimension {
+    padding: number;
+    lineThickness: number;
+    lineColor: string;
+    fontSize: number;
+    font: string;
+    textColor: string;
+    textBackgroundColor: string;
+}
+export interface IStylesWall extends IRoomBuilderStylesShared {
+    thickness: number;
+}
+export interface IStylesVertex extends Omit<IRoomBuilderStylesShared, 'fill' | IElementStyleModes.HIGHLIGHT | IElementStyleModes.ACTIVE | IElementStyleModes.ERROR> {
+    innerFill: string;
+    outerFill: string;
+    innerRadius: number;
+    outerRadius?: number;
+    [IElementStyleModes.HIGHLIGHT]: {
+        innerFill: string;
+        outerFill: string;
+        stroke?: string;
+    };
+    [IElementStyleModes.ACTIVE]: {
+        innerFill: string;
+        outerFill: string;
+        stroke?: string;
+    };
+    [IElementStyleModes.ERROR]: {
+        innerFill: string;
+        outerFill: string;
+        stroke?: string;
+    };
+}
+export interface IStylesFeature extends IStylesWall {
+}
+export interface IRoomBuilderStyles {
+    grid: IStylesGrid;
+    floor: IStylesFloor;
+    dimensions: IStylesDimension;
+    wall: IStylesWall;
+    vertex: IStylesVertex;
+    feature: IStylesFeature;
+}
+export interface IRoomBuilderThemePartial {
+    grid: Partial<IStylesGrid>;
+    floor: Partial<IStylesFloor>;
+    dimensions: Partial<IStylesDimension>;
+    wall: Partial<IStylesWall>;
+    vertex: Partial<IStylesVertex>;
+    feature: Partial<IStylesFeature>;
+}
+export declare enum SNAPPING_TYPES {
+    ANGLE = "angle"
+}
+export interface IElementAddress {
+    type: IElementName;
+    index: number;
+}
+export interface IFeatureAddress {
+    type: IFeatureName;
+    index: number;
+}
+export interface ISnapPointShared<T> {
+    type: T;
+    index: number;
+    point: ICoordinate2D;
+}
+export interface ISnapPointVertex extends ISnapPointShared<IElements.VERTEX> {
+}
+export interface ISnapPointWall extends ISnapPointShared<IElements.WALL> {
+    offset: number;
+}
+export interface ISnapPointFeature extends ISnapPointShared<IFeatureName> {
+}
+export interface ISnapPointAngle extends Omit<ISnapPointShared<SNAPPING_TYPES.ANGLE>, 'index'> {
+}
+export declare type ISnapPoint = ISnapPointVertex | ISnapPointWall | ISnapPointFeature | ISnapPointAngle;
+export interface IActiveElement extends IElementAddress {
+    snapPoint?: ISnapPoint;
+}
+export declare enum IErrorTypes {
+    HARD = "hard",
+    SOFT = "soft",
+    WARN = "warning"
+}
+export interface IErrorElement {
+    address?: IElementAddress;
+    message: string;
+    type: IErrorTypes;
+}
+export interface IElementUi {
+    path: [type: IFeatureName | IElements.WALL, index: number];
+    uiAnchor: ICoordinate2D;
+}
+export interface IElementPublic extends Pick<IElementUi, 'uiAnchor'> {
+    path: [attribute: string, index: number];
+    type: IFeatureName | IElements.WALL;
+}
+export declare enum IModes {
+    SELECT = "select",
+    DRAW = "draw"
+}
+export declare enum IUnits {
+    FEET = "feet",
+    METER = "meter",
+    INCH = "inch",
+    CM = "cm"
+}
+export interface IRoomBuilderConfigShared<T> {
+    scale: number;
+    unit: IUnits;
+    snapProximity: number;
+    styles: T;
+    zoomDefault: number;
+    translateDefault: ICoordinate2D;
+}
+export interface IRoomBuilderConfigInternal extends IRoomBuilderConfigShared<IRoomBuilderStyles> {
+}
+export interface IRoomBuilderConfigUser extends IRoomBuilderConfigShared<Partial<IRoomBuilderStyles>> {
+    theme: string;
+    zoomDisabled: boolean;
+    translateDisabled: boolean;
+}
+export interface IRoomBuilderAttributes {
+    [IElements.WALL]: string;
+    [IElements.WINDOW]?: string;
+    [IElements.DOOR]?: string;
+    [IElements.OPENING]?: string;
+}
+interface IRoomBuilderPropsShared<T> {
+    config: T;
+    attributes: IRoomBuilderAttributes;
+    layouts?: Array<string>;
+}
+export interface IRoomBuilderHookProps extends IRoomBuilderPropsShared<undefined | Partial<IRoomBuilderConfigUser>> {
+}
+export interface IRoomBuilderStateProps extends IRoomBuilderPropsShared<IRoomBuilderConfigInternal> {
+}
+export {};

package/dist/hooks/useRoomBuilder/types.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IUnits = exports.IModes = exports.IErrorTypes = exports.SNAPPING_TYPES = exports.IElementStyleModes = exports.IElements = void 0;
+var IElements;
+(function (IElements) {
+    IElements["WALL"] = "walls";
+    IElements["VERTEX"] = "vertex";
+    IElements["FEATURE"] = "features";
+    IElements["WINDOW"] = "windows";
+    IElements["DOOR"] = "doors";
+    IElements["OPENING"] = "openings";
+})(IElements = exports.IElements || (exports.IElements = {}));
+var IElementStyleModes;
+(function (IElementStyleModes) {
+    IElementStyleModes["HIGHLIGHT"] = "highlight";
+    IElementStyleModes["ACTIVE"] = "active";
+    IElementStyleModes["ERROR"] = "error";
+})(IElementStyleModes = exports.IElementStyleModes || (exports.IElementStyleModes = {}));
+var SNAPPING_TYPES;
+(function (SNAPPING_TYPES) {
+    SNAPPING_TYPES["ANGLE"] = "angle";
+})(SNAPPING_TYPES = exports.SNAPPING_TYPES || (exports.SNAPPING_TYPES = {}));
+var IErrorTypes;
+(function (IErrorTypes) {
+    IErrorTypes["HARD"] = "hard";
+    IErrorTypes["SOFT"] = "soft";
+    IErrorTypes["WARN"] = "warning";
+})(IErrorTypes = exports.IErrorTypes || (exports.IErrorTypes = {}));
+var IModes;
+(function (IModes) {
+    IModes["SELECT"] = "select";
+    IModes["DRAW"] = "draw";
+})(IModes = exports.IModes || (exports.IModes = {}));
+var IUnits;
+(function (IUnits) {
+    IUnits["FEET"] = "feet";
+    IUnits["METER"] = "meter";
+    IUnits["INCH"] = "inch";
+    IUnits["CM"] = "cm";
+})(IUnits = exports.IUnits || (exports.IUnits = {}));

package/dist/hooks/useRoomBuilder/validators.d.ts

@@ -0,0 +1,36 @@
+import { IWall, IFeatures, IElementAddress, IWalls, IErrorElement, IFeature, INewWall, ICoordinate2D, IVertex, ISnapPoint } from './types';
+export interface IFeatureValidatorInput {
+    updatedFeature: Pick<IFeature, 'length' | 'offset'> & {
+        address: IElementAddress;
+    };
+    wall: IWall;
+    features: IFeatures;
+}
+export interface IAddWallValidatorInput {
+    newWall: Pick<IWall, 'line'> & Pick<INewWall, 'snapStartTo' | 'snapEndTo'>;
+    walls: IWalls;
+    features: IFeatures;
+}
+export interface IMoveVertexValidatorInput {
+    updatedPosition: {
+        point: ICoordinate2D;
+        snapTo?: ISnapPoint;
+    };
+    walls: IWalls;
+    vertex: IVertex;
+    features: IFeatures;
+}
+declare type IValidatorFunction<T> = (input: T) => false | IErrorElement;
+export declare function isWallTooShort(input: IAddWallValidatorInput): false | IErrorElement;
+export declare function isWallIntersectingFeature(input: IAddWallValidatorInput): false | IErrorElement;
+export declare function isWallOverlappingExisitingWalls(input: IAddWallValidatorInput): false | IErrorElement;
+export declare function isWallEndingOnFeature(input: IAddWallValidatorInput): false | IErrorElement;
+export declare function isFeatureOutsideWallBounds(input: IFeatureValidatorInput): false | IErrorElement;
+export declare function isFeatureCollidingWithExistingFeature(input: IFeatureValidatorInput): false | IErrorElement;
+export declare function areWallsTooShort(input: IMoveVertexValidatorInput): false | IErrorElement;
+export declare function areWallsIntersecting(input: IMoveVertexValidatorInput): false | IErrorElement;
+export declare function areWallsOrphaningFeatures(input: IMoveVertexValidatorInput): false | IErrorElement;
+export declare function areWallsDuplicated(input: IMoveVertexValidatorInput): false | IErrorElement;
+export declare function isVertexLandingOnFeature(input: IMoveVertexValidatorInput): false | IErrorElement;
+export declare function runValidators<T>(validators: Array<IValidatorFunction<T>>, input: T): IErrorElement[] | null;
+export {};