@remotion/rough-notation 4.0.490

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { Box, Bracket, Circle, CrossedOff, Highlight, StrikeThrough, Underline, } from './Annotation';
+export type { BoxProps, BracketProps, CircleProps, CrossedOffProps, HighlightProps, StrikeThroughProps, UnderlineProps, } from './Annotation';
+export type { Padding } from './types';

package/dist/render-annotation.d.ts

@@ -0,0 +1,22 @@
+import type { OpSet } from 'roughjs/bin/core';
+import type { Rect, ResolvedAnnotationConfig, RoughAnnotationOptions } from './types';
+export declare const addKeysToPaths: (paths: string[]) => {
+    readonly d: string;
+    readonly key: string;
+}[];
+export declare function getInstructions({ rect, config, seed, options }: {
+    readonly rect: Rect;
+    readonly config: ResolvedAnnotationConfig;
+    readonly seed: number;
+    readonly options: RoughAnnotationOptions;
+}): {
+    opList: OpSet[];
+    strokeWidth: number;
+};
+export declare const renderAnnotation: ({ rect, config, seed, progress, options, }: {
+    readonly rect: Rect;
+    readonly config: ResolvedAnnotationConfig;
+    readonly seed: number;
+    readonly progress: number;
+    readonly options: RoughAnnotationOptions;
+}) => import("react/jsx-runtime").JSX.Element[];

package/dist/rough.d.ts

@@ -0,0 +1,11 @@
+import type React from 'react';
+import type { ResolvedAnnotationConfig, RoughAnnotationOptions } from './types';
+export declare const render: ({ svg, seed, element, config, scale, progress, options, }: {
+    readonly svg: SVGSVGElement;
+    readonly seed: number;
+    readonly element: HTMLElement;
+    readonly config: ResolvedAnnotationConfig;
+    readonly scale: number;
+    readonly progress: number;
+    readonly options: RoughAnnotationOptions;
+}) => React.ReactElement<unknown, string | React.JSXElementConstructor<any>>[];

package/dist/types.d.ts

@@ -0,0 +1,111 @@
+export type Rect = {
+    readonly x: number;
+    readonly y: number;
+    readonly w: number;
+    readonly h: number;
+};
+export type Padding = {
+    readonly left: number;
+    readonly right: number;
+    readonly top: number;
+    readonly bottom: number;
+};
+export type Box = 'inside' | 'around';
+export type RoughAnnotationOptions = {
+    readonly roughness?: number;
+    readonly maxRandomnessOffset?: number;
+    readonly bowing?: number;
+    readonly curveFitting?: number;
+    readonly curveTightness?: number;
+    readonly curveStepCount?: number;
+    readonly disableMultiStroke?: boolean;
+    readonly preserveVertices?: boolean;
+};
+export type SharedRoughAnnotationOptions = Omit<RoughAnnotationOptions, 'curveFitting' | 'curveTightness' | 'curveStepCount'>;
+export type CurveAnnotationOptions = Pick<RoughAnnotationOptions, 'curveFitting' | 'curveTightness' | 'curveStepCount'>;
+type ColorConfig = {
+    readonly color?: string;
+};
+type StrokeConfig = ColorConfig & {
+    readonly strokeWidth?: number;
+};
+type PaddingConfig = {
+    readonly padding?: Partial<Padding>;
+};
+type UnderlinePaddingConfig = {
+    readonly padding?: {
+        readonly top?: number;
+    };
+};
+type IterationConfig = {
+    readonly iterations?: number;
+};
+type RtlConfig = {
+    readonly rtl?: boolean;
+};
+type BracketConfig = {
+    readonly bracketLeft?: boolean;
+    readonly bracketRight?: boolean;
+    readonly bracketTop?: boolean;
+    readonly bracketBottom?: boolean;
+};
+export type UnderlineConfig = StrokeConfig & UnderlinePaddingConfig & IterationConfig & RtlConfig;
+export type StrikeThroughConfig = StrokeConfig & IterationConfig & RtlConfig;
+export type BoxConfig = StrokeConfig & PaddingConfig & IterationConfig;
+export type BracketAnnotationConfig = BracketConfig & StrokeConfig & PaddingConfig;
+export type CrossedOffConfig = StrokeConfig & IterationConfig & RtlConfig;
+export type CircleConfig = StrokeConfig & PaddingConfig & IterationConfig & {
+    readonly box?: Box;
+};
+export type HighlightConfig = ColorConfig & PaddingConfig & IterationConfig & RtlConfig;
+export type AnnotationConfig = {
+    readonly type: 'none';
+} | (UnderlineConfig & {
+    readonly type: 'underline';
+}) | (StrikeThroughConfig & {
+    readonly type: 'strike-through';
+}) | (BoxConfig & {
+    readonly type: 'box';
+}) | (BracketAnnotationConfig & {
+    readonly type: 'bracket';
+}) | (CrossedOffConfig & {
+    readonly type: 'crossed-off';
+}) | (CircleConfig & {
+    readonly type: 'circle';
+}) | (HighlightConfig & {
+    readonly type: 'highlight';
+});
+type ResolvedSharedConfig = {
+    readonly color: string;
+    readonly strokeWidth: number;
+};
+type ResolvedPaddingConfig = {
+    readonly padding: Padding;
+};
+type ResolvedIterationConfig = {
+    readonly iterations: number;
+};
+type ResolvedRtlConfig = {
+    readonly rtl: boolean;
+};
+export type ResolvedAnnotationConfig = {
+    readonly type: 'none';
+} | ({
+    readonly type: 'underline';
+} & ResolvedSharedConfig & ResolvedPaddingConfig & ResolvedIterationConfig & ResolvedRtlConfig) | ({
+    readonly type: 'strike-through';
+} & ResolvedSharedConfig & ResolvedIterationConfig & ResolvedRtlConfig) | ({
+    readonly type: 'box';
+} & ResolvedSharedConfig & ResolvedPaddingConfig & ResolvedIterationConfig) | ({
+    readonly type: 'bracket';
+} & Required<BracketConfig> & ResolvedSharedConfig & ResolvedPaddingConfig) | ({
+    readonly type: 'crossed-off';
+} & ResolvedSharedConfig & ResolvedIterationConfig & ResolvedRtlConfig) | ({
+    readonly type: 'circle';
+    readonly box: Box;
+} & ResolvedSharedConfig & ResolvedPaddingConfig & ResolvedIterationConfig) | ({
+    readonly type: 'highlight';
+} & Omit<ResolvedSharedConfig, 'strokeWidth'> & ResolvedPaddingConfig & ResolvedIterationConfig & ResolvedRtlConfig);
+export declare const resolveRoughOptions: (options: RoughAnnotationOptions) => RoughAnnotationOptions;
+export declare const resolveAnnotationConfig: (config: AnnotationConfig) => ResolvedAnnotationConfig;
+export {};

package/package.json

@@ -0,0 +1,61 @@
+{
+	"name": "@remotion/rough-notation",
+	"version": "4.0.490",
+	"description": "Rough annotation primitives for Remotion",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"module": "dist/esm/index.mjs",
+	"repository": {
+		"url": "https://github.com/remotion-dev/remotion/tree/main/packages/rough-notation"
+	},
+	"type": "module",
+	"scripts": {
+		"test": "bun test src/test",
+		"formatting": "oxfmt src --check",
+		"format": "oxfmt src",
+		"lint": "eslint src",
+		"watch": "tsgo -w",
+		"make": "tsgo && bun --env-file=../.env.bundle bundle.ts"
+	},
+	"author": "Jonny Burger <jonny@remotion.dev>",
+	"contributors": [
+		"Mohit Yadav <yo@mohitya.dev>"
+	],
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/remotion-dev/remotion/issues"
+	},
+	"dependencies": {
+		"@remotion/paths": "4.0.490",
+		"remotion": "4.0.490",
+		"roughjs": "4.6.6"
+	},
+	"peerDependencies": {
+		"react": ">=16.8.0",
+		"react-dom": ">=16.8.0"
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"module": "./dist/esm/index.mjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./package.json": "./package.json"
+	},
+	"devDependencies": {
+		"react": "19.2.3",
+		"react-dom": "19.2.3",
+		"@remotion/eslint-config-internal": "4.0.490",
+		"eslint": "9.19.0",
+		"@typescript/native-preview": "7.0.0-dev.20260217.1"
+	},
+	"keywords": [
+		"remotion",
+		"rough-notation",
+		"annotations"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"homepage": "https://www.remotion.dev/docs/rough-notation"
+}