@snaptrude/plugin-core 0.0.3 → 0.0.5

package/dist/api/tools/transform.d.ts

@@ -1,17 +1,32 @@
+import * as z from "zod";
 import { PluginApiReturn } from "../../types";
 export declare abstract class PluginTransformApi {
     constructor();
     abstract move({ componentIds, displacement, }: PluginMoveArgs): PluginApiReturn<void>;
     abstract rotate({ componentIds, angle, axis, pivot, }: PluginRotateArgs): PluginApiReturn<void>;
 }
-export type PluginMoveArgs = {
-    componentIds: string[];
-    displacement: [number, number, number];
-};
-export type PluginRotateArgs = {
-    componentIds: string[];
-    angle: number;
-    axis: [number, number, number];
-    pivot: [number, number, number];
-};
+export declare const PluginMoveArgs: z.ZodObject<{
+    componentIds: z.ZodArray<z.ZodString>;
+    displacement: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginMoveArgs = z.infer<typeof PluginMoveArgs>;
+export declare const PluginRotateArgs: z.ZodObject<{
+    componentIds: z.ZodArray<z.ZodString>;
+    angle: z.ZodNumber;
+    axis: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+    pivot: z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        z: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type PluginRotateArgs = z.infer<typeof PluginRotateArgs>;
 //# sourceMappingURL=transform.d.ts.map

package/dist/api/tools/transform.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../src/api/tools/transform.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,8BAAsB,kBAAkB;;aAGtB,IAAI,CAAC,EACnB,YAAY,EACZ,YAAY,GACb,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC;aAEzB,MAAM,CAAC,EACrB,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,KAAK,GACN,EAAE,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC;CAC5C;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,EAAE,MAAM,EAAE,CAAA;IACtB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC,CAAA"}
+{"version":3,"file":"transform.d.ts","sourceRoot":"","sources":["../../../src/api/tools/transform.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAG7C,8BAAsB,kBAAkB;;aAGtB,IAAI,CAAC,EACnB,YAAY,EACZ,YAAY,GACb,EAAE,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC;aAEzB,MAAM,CAAC,EACrB,YAAY,EACZ,KAAK,EACL,IAAI,EACJ,KAAK,GACN,EAAE,gBAAgB,GAAG,eAAe,CAAC,IAAI,CAAC;CAC5C;AAED,eAAO,MAAM,cAAc;;;;;;;iBAGzB,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAE3D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;iBAK3B,CAAA;AAEF,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA"}

package/dist/api/units/index.d.ts

@@ -0,0 +1,95 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../types";
+export declare abstract class PluginUnitsApi {
+    constructor();
+    /**
+     * Convert a value from the given unit to Snaptrude's internal (Babylon) units.
+     *
+     * Use this when you have a measurement in real-world units (e.g. meters, feet)
+     * and need to convert it to the coordinate system used by Snaptrude internally.
+     *
+     * @param args.unit - The source unit to convert from (e.g. `"meters"`, `"feet-inches"`)
+     * @param args.value - The numeric value in the source unit
+     * @returns An object containing the converted `value` in Snaptrude/Babylon units
+     *
+     * @example
+     * ```ts
+     * const result = await snaptrude.units.convertFrom({ unit: "meters", value: 5 })
+     * // result.value is 5 meters expressed in Babylon units
+     * ```
+     */
+    abstract convertFrom(args: PluginUnitsConvertFromArgs): PluginApiReturn<PluginUnitsConvertFromResult>;
+    /**
+     * Convert a value from Snaptrude's internal (Babylon) units to the given unit.
+     *
+     * Use this when you have a value in Snaptrude's internal coordinate system
+     * and need to express it in real-world units (e.g. meters, feet).
+     *
+     * @param args.unit - The target unit to convert to (e.g. `"meters"`, `"feet-inches"`)
+     * @param args.value - The numeric value in Snaptrude/Babylon units
+     * @returns An object containing the converted `value` in the target unit
+     *
+     * @example
+     * ```ts
+     * const result = await snaptrude.units.convertTo({ unit: "feet-inches", value: 1.2 })
+     * // result.value is 1.2 Babylon units expressed in feet
+     * ```
+     */
+    abstract convertTo(args: PluginUnitsConvertToArgs): PluginApiReturn<PluginUnitsConvertToResult>;
+}
+/**
+ * Supported unit types for conversion.
+ *
+ * - `meters` — Metric meters
+ * - `feet-inches` — Imperial feet (1 foot = 12 inches)
+ * - `inches` — Imperial inches
+ * - `centimeters` — Metric centimeters
+ * - `millimeters` — Metric millimeters
+ * - `kilometers` — Metric kilometers
+ * - `miles` — Imperial miles
+ */
+export declare const PUnitType: z.ZodEnum<{
+    meters: "meters";
+    "feet-inches": "feet-inches";
+    inches: "inches";
+    centimeters: "centimeters";
+    millimeters: "millimeters";
+    kilometers: "kilometers";
+    miles: "miles";
+}>;
+export type PUnitType = z.infer<typeof PUnitType>;
+export declare const PluginUnitsConvertFromArgs: z.ZodObject<{
+    unit: z.ZodEnum<{
+        meters: "meters";
+        "feet-inches": "feet-inches";
+        inches: "inches";
+        centimeters: "centimeters";
+        millimeters: "millimeters";
+        kilometers: "kilometers";
+        miles: "miles";
+    }>;
+    value: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginUnitsConvertFromArgs = z.infer<typeof PluginUnitsConvertFromArgs>;
+export declare const PluginUnitsConvertFromResult: z.ZodObject<{
+    value: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginUnitsConvertFromResult = z.infer<typeof PluginUnitsConvertFromResult>;
+export declare const PluginUnitsConvertToArgs: z.ZodObject<{
+    unit: z.ZodEnum<{
+        meters: "meters";
+        "feet-inches": "feet-inches";
+        inches: "inches";
+        centimeters: "centimeters";
+        millimeters: "millimeters";
+        kilometers: "kilometers";
+        miles: "miles";
+    }>;
+    value: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginUnitsConvertToArgs = z.infer<typeof PluginUnitsConvertToArgs>;
+export declare const PluginUnitsConvertToResult: z.ZodObject<{
+    value: z.ZodNumber;
+}, z.core.$strip>;
+export type PluginUnitsConvertToResult = z.infer<typeof PluginUnitsConvertToResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/units/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/units/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAE7C,8BAAsB,cAAc;;IAGlC;;;;;;;;;;;;;;;OAeG;aACa,WAAW,CACzB,IAAI,EAAE,0BAA0B,GAC/B,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;OAeG;aACa,SAAS,CACvB,IAAI,EAAE,wBAAwB,GAC7B,eAAe,CAAC,0BAA0B,CAAC;CAC/C;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS;;;;;;;;EAQpB,CAAA;AAEF,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAA;AAEjD,eAAO,MAAM,0BAA0B;;;;;;;;;;;iBAGrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,eAAO,MAAM,4BAA4B;;iBAEvC,CAAA;AAEF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAEvF,eAAO,MAAM,wBAAwB;;;;;;;;;;;iBAGnC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA;AAE/E,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA"}