@frdt/frdt 0.2.0

package/index.d.ts

@@ -0,0 +1,129 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+/**
+ * Which binding artifact the generated loader actually loaded: `'native'` for
+ * a native addon, otherwise the `platformArchABI` of the WASI flavor. Every
+ * flavor napi-rs can build is listed, because `NAPI_RS_NATIVE_LIBRARY_PATH`
+ * can point the loader at a WASI artifact this package does not build itself.
+ */
+export declare const __napiBindingTarget: 'native' | 'wasm32-wasi' | 'wasm32-wasip1'
+
+/** An open `.brson` document. */
+export declare class Document {
+  /** Open a Resonite `.brson` (or a frdt `FRWK` work file). */
+  static open(bytes: Uint8Array): Document
+  /** A document with one empty root slot. */
+  static empty(rootName: string, versionNumber: string, featureFlags: Array<FeatureFlag>): Document
+  root(): Slot
+  slotById(id: string): Slot
+  versionNumber(): string
+  featureFlags(): Array<FeatureFlag>
+  types(): Array<string>
+  typeVersion(name: string): number | null
+  slotCount(): number
+  componentCount(): number
+  assets(): Array<AssetInfo>
+  /** Copy `slots` (all from one document) under `parent`, renumbering ids. */
+  import(parent: Slot, slots: Array<Slot>): Import
+  addSlot(parent: Slot, name: string): Slot
+  addComponent(slot: Slot, typeName: string, typeVersion: number | undefined | null, fields: Array<Field>): NewComponent
+  moveSlot(slot: Slot, newParent: Slot): void
+  removeSlot(slot: Slot): void
+  /** Trim `Types` and `TypeVersions` to what remains. Returns removed names. */
+  rebuildTypes(): Array<string>
+  /** The Resonite `.brson` bytes. */
+  writeBrson(): Buffer
+}
+
+/** What `Document.import` copied. */
+export declare class Import {
+  /** The copied slots in the destination, in the order given. */
+  slots(): Array<Slot>
+  /** The destination id that replaced a source id. */
+  newId(sourceId: string): string | null
+  /** Source ids the copy still names but that were not copied. */
+  unresolved(): Array<string>
+  assetCount(): number
+}
+
+/** A slot in a `Document`. It keeps pointing at the same slot across edits. */
+export declare class Slot {
+  name(): string
+  id(): string
+  parentReference(): string | null
+  children(): Array<Slot>
+  components(): Array<ComponentInfo>
+  /** A slot field such as `Name` or `Position`. */
+  get(field: string): Value
+  /** Replace a slot field. A `{ID, Data}` field keeps its id. */
+  set(field: string, value: Value): void
+  /** A field of the `component`-th component. `null` when the value is null. */
+  componentValue(component: number, field: string): Value | null
+  setComponentValue(component: number, field: string, value?: Value | undefined | null): void
+}
+
+export interface AssetInfo {
+  id: string
+  typeIndex?: number
+}
+
+export interface ComponentInfo {
+  typeIndex: number
+  typeName: string
+  /** Every `{ID, Data: string}` inside the component, as in the Rust crate. */
+  references: Array<string>
+}
+
+export interface DynamicVariable {
+  /** `"value"`, `"reference"`, or `"space"`. */
+  kind: string
+  typeName: string
+  variableName?: string
+  spaceName?: string
+  value?: Value
+  reference?: Value
+}
+
+export interface FeatureFlag {
+  name: string
+  value: number
+}
+
+/** One field of a new component. A missing or `null` value writes null. */
+export interface Field {
+  name: string
+  value?: Value | null
+}
+
+export interface NewComponent {
+  /** Position in `Slot.components()`. */
+  index: number
+  id: string
+}
+
+/** Count slots, components, and dynamic variables without opening a document. */
+export declare function summarize(bytes: Uint8Array): Summary
+
+export interface Summary {
+  slotCount: number
+  componentCount: number
+  types: Array<string>
+  dynamicVariables: Array<DynamicVariable>
+}
+
+/**
+ * A field value. References are the target's id as a `string`.
+ *
+ * `int` crosses as a JavaScript number, so it is exact up to 2^53.
+ */
+export type Value =
+  | { kind: 'string'; value: string }
+  | { kind: 'int'; value: number }
+  | { kind: 'float'; value: number }
+  | { kind: 'bool'; value: boolean }
+  | { kind: 'float3'; value: Array<number> }
+  | { kind: 'floatQ'; value: Array<number> }
+
+/** The leading `[year, month, day]` of a `VersionNumber`, or `null`. */
+export declare function versionDate(versionNumber: string): Array<number> | null