@vertexvis/viewer-toolkit-react 0.0.1

package/dist/util/dom/elements.d.ts

@@ -0,0 +1 @@
+export declare const targetIsElement: <T extends HTMLElement = HTMLElement>(target: EventTarget, tagName: string) => target is T;

package/dist/util/geometry/__tests__/bounding-box.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/geometry/__tests__/vector3.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/geometry/bounding-box.d.ts

@@ -0,0 +1,4 @@
+import { BoundingBox, Vector3 } from '@vertexvis/geometry';
+export declare function corners(box: BoundingBox.BoundingBox): Vector3.Vector3[];
+export declare function minLength(box: BoundingBox.BoundingBox): number;
+export declare function equals(box1: BoundingBox.BoundingBox, box2: BoundingBox.BoundingBox): boolean;

package/dist/util/geometry/vector3.d.ts

@@ -0,0 +1,2 @@
+import { Vector3 } from '@vertexvis/geometry';
+export declare function isParallelTo(a: Vector3.Vector3, b: Vector3.Vector3): boolean;

package/dist/util/logging/__tests__/logger.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/logging/logger.d.ts

@@ -0,0 +1,8 @@
+interface Logger {
+    error: (message: string, err?: any) => void;
+    warn: (message: string, err?: any) => void;
+    info: (message: string, obj?: any) => void;
+    debug: (message: string, obj?: any) => void;
+}
+export declare const logger: Logger;
+export {};

package/dist/util/measurement/units.d.ts

@@ -0,0 +1,57 @@
+import type { DistanceUnitType as SdkDistanceUnitType } from '@vertexvis/viewer/dist/types/lib/types';
+/**
+ * Types of distance units
+ */
+declare enum DistanceUnit {
+    mm = "millimeters",
+    cm = "centimeters",
+    m = "meters",
+    in = "inches",
+    ft = "feet"
+}
+/**
+ * This is equivalent to:
+ * type DistanceUnitType = 'mm' | 'cm' | 'm' | 'in' | 'ft';
+ */
+export type DistanceUnitType = keyof typeof DistanceUnit;
+export type NumberFormatter = (value: number) => string;
+/**
+ * Converts a value from non-system units (in) to base system units (mm) using supplied conversion factor.
+ *
+ * @param value Value to convert.
+ * @param fromUnit Unit converting from (to base system units)
+ */
+export declare const convertFrom: (value: number, fromUnit: DistanceUnitType) => number;
+/**
+ * Converts a value from base system units (mm) to another unit based on supplied conversion factor.
+ *
+ * @param value Value to convert.
+ * @param toUnit Unit to convert to (from base system units)
+ */
+export declare const convertTo: (value: number, toUnit: DistanceUnitType) => number;
+/**
+ * Formats a numeric value as a string with supplied unit and decimal places.
+ *
+ * @param value
+ * @param unit
+ * @param decimalPlaces
+ */
+export declare const formatWithUnit: (value: number, unit: string, decimalPlaces: number) => string;
+/**
+ * Formats a (millimeter based) numeric distance value
+ * for display, as converted to specificied units.
+ *
+ * @param value
+ * @param unit
+ * @param decimalPlaces
+ */
+export declare const formatDistance: (value: number, unit: DistanceUnitType, decimalPlaces: number) => string;
+/**
+ * Returns a distance formatter function for a given pair of unit and decimal place params.
+ *
+ * @param unit
+ * @param decimalPlaces
+ */
+export declare const createDistanceFormatter: (unit: DistanceUnitType, decimalPlaces: number) => NumberFormatter;
+export declare function toUnitType(s: DistanceUnitType): SdkDistanceUnitType;
+export {};

package/dist/util/recoil/__tests__/actions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/recoil/actions.d.ts

@@ -0,0 +1,86 @@
+import { CallbackInterface, RecoilValue, Snapshot } from 'recoil';
+export interface TryGetPromiseResult<T> {
+    value?: T;
+    error?: Error;
+}
+/**
+ * A Recoil Snapshot with an additional `tryGetPromise` method that wraps the
+ * `getPromise` method in a try/catch and returns an object with either the
+ * value of the Recoil atom or selector, or the error encountered.
+ */
+export interface SnapshotWithErrorHandling extends Snapshot {
+    /**
+     * Attempts to retrieve the value of this Recoil atom or selector, and returns
+     * the value if one is present. If the value received is `undefined`, the provided
+     * `error` or a generic error will be thrown.
+     *
+     * @param value - the Recoil atom or selector with a potentially undefined value
+     * @param error - an optional custom Error to throw if no value is present
+     * @throws the provided `error` or a generic Error if no value is present
+     * @returns the value of the Recoil atom or selector
+     */
+    getPromiseRequired: <T>(value: RecoilValue<T | undefined>, error?: Error) => Promise<T>;
+    /**
+     * Attempts to retrieve the value of this Recoil atom or selector, and returns
+     * a `TryGetPromiseResult` with the value or the error encountered when attempting
+     * to retrieve the value.
+     *
+     * @param value - the Recoil atom or selector
+     * @returns a `TryGetPromiseResult` wrapper containing the value or error
+     */
+    tryGetPromise: <T>(value: RecoilValue<T>) => Promise<TryGetPromiseResult<T>>;
+}
+export interface CallbackInterfaceWithErrorHandling extends CallbackInterface {
+    snapshot: SnapshotWithErrorHandling;
+}
+declare class DefaultRecoilDeps {
+}
+export declare const DefaultRecoilCallbackDepsBehavior: DefaultRecoilDeps;
+/**
+ * Returns a Recoil callback that can be used for action hooks.
+ *
+ * This uses `useRecoilCallback` but the deps implementation differs from
+ * Recoil. If no deps are provided, then it will always return the same function
+ * vs returning a new function.
+ *
+ * If you want to use the original Recoil callback behavior, pass
+ * `DefaultRecoilCallbackDepsBehavior`.
+ *
+ * @param fn The callback.
+ * @param deps The deps to memoize over. Defaults to `[]`.
+ * @returns A callback function
+ * @see https://recoiljs.org/docs/api-reference/core/useRecoilCallback
+ */
+export declare function useActionCallback<Args extends ReadonlyArray<unknown>, Return>(fn: (cb: CallbackInterfaceWithErrorHandling) => (...args: Args) => Return, deps?: ReadonlyArray<unknown> | DefaultRecoilDeps): (...args: Args) => Return;
+/**
+ * Returns a callback that can be used with `useActionCallback` or `useRecoilCallback`,
+ * and automatically handles retention of the `snapshot` object for use with asynchronous
+ * selectors.
+ *
+ * This function expects a callback that would ordinarily be passed to `useActionCallback`
+ * or `useRecoilCallback`, but that returns an asynchronous action where the `snapshot` is
+ * used.
+ *
+ * @example
+ *
+ * const asyncSelector = selector({
+ *   key: 'asyncSelector',
+ *   get: async ({ get }) => {
+ *     return await fetch('/api/item');
+ *   }
+ * })
+ *
+ * useActionCallback(
+ *   retainSnapshot(
+ *     ({ snapshot }) => async () => {
+ *       const asyncValue = await snapshot.getPromise(asyncSelector);
+ *     }
+ *   )
+ * )
+ *
+ * @param fn The callback.
+ * @returns The callback wrapped with a retain/release of the underlying snapshot.
+ */
+export declare function retainSnapshot<Args extends ReadonlyArray<unknown>, Return>(fn: (cb: CallbackInterfaceWithErrorHandling) => (...args: Args) => Promise<Return>): (cb: CallbackInterfaceWithErrorHandling) => (...args: Args) => Promise<Return>;
+export declare function createGetPromiseRequiredWrapper(snapshot: Snapshot): <T>(recoilValue: RecoilValue<T | undefined>, error?: Error) => Promise<T>;
+export {};

package/dist/util/recoil/reducer.d.ts

@@ -0,0 +1,9 @@
+import { RecoilState } from 'recoil';
+export interface UseRecoilReducerProps<S, A> {
+    reducer: (state: S, action: A) => S;
+    atom: RecoilState<S>;
+}
+export type UseRecoilReducer<S, A> = [state: S, dispatch: (action: A) => void];
+export type UseRecoilReducerDispatch<A> = (action: A) => void;
+export declare const useRecoilReducer: <S, A>({ reducer, atom, }: UseRecoilReducerProps<S, A>) => UseRecoilReducer<S, A>;
+export declare const useRecoilReducerDispatch: <S, A>({ reducer, atom, }: UseRecoilReducerProps<S, A>) => UseRecoilReducerDispatch<A>;

package/dist/util/recoil/synchronized-prop.d.ts

@@ -0,0 +1,2 @@
+import { RecoilState } from 'recoil';
+export declare const useSynchronizedProp: <T>(state: RecoilState<T>, value: T) => void;

package/dist/util/refs/callback-ref.d.ts

@@ -0,0 +1,10 @@
+import React from 'react';
+export interface UseCallbackRefProps<T> {
+    initial?: T | null;
+}
+interface UseCallbackRef<T> {
+    element: T | null;
+    callback: React.RefCallback<T>;
+}
+export declare function useCallbackRef<T>(props?: UseCallbackRefProps<T>): UseCallbackRef<T>;
+export {};

package/dist/util/refs/recoil-ref.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+import { RecoilState } from 'recoil';
+export interface UseRecoilRefProps<T> {
+    state: RecoilState<T | null | undefined>;
+}
+export declare function useRecoilRef<T>({ state, }: UseRecoilRefProps<T>): React.RefCallback<T>;

package/dist/util/scene-tree/customization.d.ts

@@ -0,0 +1,3 @@
+import { AssemblyBackgroundColors, AssemblyFont } from '@state/scene-tree/types';
+export declare function styleFromOptionalFont(font?: Partial<AssemblyFont>): Record<string, string | undefined>;
+export declare function styleFromOptionalBackgroundColors(backgroundColors?: Partial<AssemblyBackgroundColors>): Record<string, string | undefined>;

package/dist/util/sdk-mapping/__tests__/config.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/util/sdk-mapping/config.d.ts

@@ -0,0 +1,2 @@
+import { PartialConfig } from '@vertexvis/viewer/dist/types/lib/config';
+export declare function toSdkConfig(config: PartialConfig['network'] | PartialConfig): PartialConfig;

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@vertexvis/viewer-toolkit-react",
+  "version": "0.0.1",
+  "description": "Components for common Vertex viewer usage patterns.",
+  "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Vertexvis/vertex-web-toolkit.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "main": "dist/bundle.cjs.js",
+  "module": "dist/bundle.cjs.js",
+  "es2015": "dist/bundle.esm.js",
+  "es2017": "dist/bundle.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "start": "rollup --config ./rollup.config.mjs --watch",
+    "dev": "yarn start",
+    "build": "rollup --config ./rollup.config.mjs",
+    "test": "jest",
+    "test:ci": "yarn test:coverage",
+    "test:coverage": "yarn test --coverage",
+    "clean": "rm -fr ./dist && mkdir ./dist",
+    "format": "yarn lint --fix",
+    "lint": "eslint --ext .ts,.tsx,.js,.jsx --ignore-path .gitignore",
+    "prebuild": "yarn clean"
+  },
+  "dependencies": {
+    "@types/classnames": "^2.3.1",
+    "@vertexvis/utils": "^0.23.0",
+    "@vertexvis/viewer-react": "^0.23.0",
+    "camel-case": "^4.1.2",
+    "classnames": "^2.3.1",
+    "pino": "^9.6.0",
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0",
+    "recoil": "^0.7.7",
+    "tslib": "^2.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.24.5",
+    "@babel/preset-typescript": "7.24.1",
+    "@swc/core": "^1.11.9",
+    "@swc/jest": "^0.2.37",
+    "@tailwindcss/postcss": "^4.0.12",
+    "@testing-library/react": "^16.2.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/jest": "^27.5.1",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@vertexvis/build-tools": "^0.10.1",
+    "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.1",
+    "@vertexvis/jest-config-vertexvis": "^0.5.5",
+    "@vertexvis/ui-react": "0.1.1-canary.2",
+    "@vertexvis/viewer-react": "^0.23.0-canary.9",
+    "autoprefixer": "^10.4.20",
+    "eslint": "8.49.0",
+    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-storybook": "0.6.15",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "postcss": "^8.5.3",
+    "prettier": "^3.5.3",
+    "rollup": "^4.34.9",
+    "rollup-plugin-livereload": "^2.0.5",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-serve": "^3.0.0",
+    "storybook": "8.6.4",
+    "tailwindcss": "^4.0.12",
+    "ts-jest": "^29.2.6"
+  },
+  "gitHead": "b5e9a4111675a558ee5f642a7b376d040aa120b7"
+}