@kodexa-ai/document-wasm-ts 8.0.0-develop-20922720042 → 8.0.0-develop-20929633869

package/dist/TaxonomyAccessor.d.ts

@@ -0,0 +1,362 @@
+/**
+ * TaxonomyAccessor - Accessor for taxonomies within a KddbDocument
+ *
+ * Provides access to taxonomy definitions stored in the document.
+ * Taxonomies define the structure and types of data that can be extracted,
+ * including taxon paths, data types, validation rules, and metadata.
+ *
+ * Taxonomies are hierarchical structures where each node (taxon) defines
+ * a field type with properties like data type, validation rules, and UI hints.
+ * Storing taxonomies in the document enables automatic taxon resolution
+ * when creating data attributes.
+ *
+ * Usage:
+ * - document.taxonomies.store(taxonomy) - Store a taxonomy definition
+ * - document.taxonomies.getByRef(ref) - Retrieve by reference
+ * - document.taxonomies.getAll() - List all taxonomies
+ * - document.taxonomies.getTaxonByPath(ref, path) - Get specific taxon
+ *
+ * @example
+ * ```typescript
+ * // Store a taxonomy
+ * const taxonomy = await doc.taxonomies.store({
+ *   ref: "acme/invoice:1.0.0",
+ *   name: "Invoice Schema",
+ *   taxons: [{
+ *     name: "Invoice",
+ *     group: true,
+ *     children: [{
+ *       name: "Amount",
+ *       taxonType: "currency",
+ *       path: "Invoice/Amount"
+ *     }]
+ *   }]
+ * });
+ *
+ * // Create an attribute using taxon resolution
+ * const attr = await doc.dataAttributes.create(dataObjectId, {
+ *   taxonomyRef: "acme/invoice:1.0.0",
+ *   taxonPath: "Invoice/Amount",
+ *   decimalValue: 150.00
+ * });
+ * // attr.typeAtCreation is automatically set to "currency"
+ * ```
+ */
+import type { Taxonomy, Taxon } from './wasm/types';
+/**
+ * Input type for storing a taxonomy
+ */
+export interface TaxonomyInput {
+    /**
+     * Unique reference identifier for the taxonomy
+     * @example "acme/invoice:1.0.0"
+     */
+    ref: string;
+    /**
+     * Human-readable name for the taxonomy
+     * @example "Invoice Processing Schema"
+     */
+    name: string;
+    /**
+     * Optional version string
+     * @example "1.0.0"
+     */
+    version?: string;
+    /**
+     * Type of taxonomy (e.g., "EXTRACTION", "LABELING")
+     */
+    type?: string;
+    /**
+     * Whether the taxonomy is enabled
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Optional description of the taxonomy
+     */
+    description?: string;
+    /**
+     * Root-level taxons in the taxonomy hierarchy
+     */
+    taxons: TaxonInput[];
+}
+/**
+ * Input type for defining a taxon (taxonomy node)
+ */
+export interface TaxonInput {
+    /**
+     * Optional unique identifier for the taxon
+     */
+    id?: string;
+    /**
+     * Internal name used for tag matching and path construction
+     * @example "LineItemAmount"
+     */
+    name: string;
+    /**
+     * Human-readable label for UI display
+     * @example "Line Item Amount"
+     */
+    label?: string;
+    /**
+     * External name used in exports and serialization
+     * @example "lineItemAmount"
+     */
+    externalName?: string;
+    /**
+     * Optional description of this taxon
+     */
+    description?: string;
+    /**
+     * Full path in taxonomy hierarchy (auto-computed if not provided)
+     * @example "Invoice/LineItems/Amount"
+     */
+    path?: string;
+    /**
+     * Data type for this taxon
+     * @example "currency", "string", "date", "boolean", "decimal"
+     */
+    taxonType?: string;
+    /**
+     * Whether this taxon represents a group (container for child taxons)
+     * @default false
+     */
+    group?: boolean;
+    /**
+     * Whether the taxon is enabled for extraction
+     * @default true
+     */
+    enabled?: boolean;
+    /**
+     * Whether the value can be null
+     * @default false
+     */
+    nullable?: boolean;
+    /**
+     * Display order within parent
+     */
+    order?: number;
+    /**
+     * Value extraction path type
+     * @example "EXTERNAL", "EXPRESSION", "METADATA"
+     */
+    valuePath?: string;
+    /**
+     * Expression for value extraction (when valuePath is "EXPRESSION")
+     */
+    expression?: string;
+    /**
+     * Semantic definition for formulas
+     */
+    semanticDefinition?: string;
+    /**
+     * Whether to evaluate post-expression after extraction
+     */
+    usePostExpression?: boolean;
+    /**
+     * Post-processing expression
+     */
+    postExpression?: string;
+    /**
+     * Whether to use fallback expression when no value found
+     */
+    enableFallbackExpression?: boolean;
+    /**
+     * Fallback expression when primary extraction fails
+     */
+    fallbackExpression?: string;
+    /**
+     * Whether this taxon can have multiple values
+     */
+    multiValue?: boolean;
+    /**
+     * Whether users can edit this value in the UI
+     */
+    userEditable?: boolean;
+    /**
+     * Type-specific feature configuration
+     */
+    typeFeatures?: Record<string, unknown>;
+    /**
+     * Additional properties
+     */
+    properties?: Record<string, unknown>;
+    /**
+     * Generic metadata
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Child taxons in the hierarchy
+     */
+    children?: TaxonInput[];
+}
+/**
+ * TaxonomyAccessor - access taxonomies stored in a document
+ *
+ * This is an internal accessor class. Access via document.taxonomies property.
+ */
+export declare class TaxonomyAccessor {
+    private documentRef;
+    constructor(documentRef: number);
+    /**
+     * Store or update a taxonomy in the document
+     *
+     * If a taxonomy with the same ref already exists, it will be updated.
+     * The taxon hierarchy paths are automatically computed if not provided.
+     *
+     * @param taxonomy The taxonomy definition to store
+     * @returns The stored taxonomy with assigned ID
+     * @throws Error if storage fails
+     *
+     * @example
+     * ```typescript
+     * const stored = await doc.taxonomies.store({
+     *   ref: "company/schema:1.0.0",
+     *   name: "Company Schema",
+     *   type: "EXTRACTION",
+     *   taxons: [
+     *     {
+     *       name: "Invoice",
+     *       group: true,
+     *       children: [
+     *         { name: "Number", taxonType: "string" },
+     *         { name: "Amount", taxonType: "currency" }
+     *       ]
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    store(taxonomy: TaxonomyInput): Promise<Taxonomy>;
+    /**
+     * Get a taxonomy by its reference identifier
+     *
+     * @param ref The taxonomy reference (e.g., "kodexa/invoice:1.0.0")
+     * @returns The taxonomy or null if not found
+     *
+     * @example
+     * ```typescript
+     * const taxonomy = await doc.taxonomies.getByRef("acme/invoice:1.0.0");
+     * if (taxonomy) {
+     *   console.log(`Found: ${taxonomy.name} with ${taxonomy.taxons.length} root taxons`);
+     * }
+     * ```
+     */
+    getByRef(ref: string): Promise<Taxonomy | null>;
+    /**
+     * Get all taxonomies stored in the document
+     *
+     * @returns Array of all taxonomies
+     *
+     * @example
+     * ```typescript
+     * const all = await doc.taxonomies.getAll();
+     * console.log(`Document has ${all.length} taxonomies`);
+     * for (const tax of all) {
+     *   console.log(`- ${tax.ref}: ${tax.name}`);
+     * }
+     * ```
+     */
+    getAll(): Promise<Taxonomy[]>;
+    /**
+     * Delete a taxonomy by its reference
+     *
+     * @param ref The taxonomy reference to delete
+     * @returns true if deleted, false if not found
+     *
+     * @example
+     * ```typescript
+     * const deleted = await doc.taxonomies.delete("old/schema:1.0.0");
+     * if (deleted) {
+     *   console.log("Taxonomy removed");
+     * }
+     * ```
+     */
+    delete(ref: string): Promise<boolean>;
+    /**
+     * Get a specific taxon by path within a taxonomy
+     *
+     * This is useful for looking up taxon metadata like type, label,
+     * or validation rules before creating attributes.
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @param taxonPath The taxon path (e.g., "Invoice/LineItem/Amount")
+     * @returns The taxon or null if not found
+     *
+     * @example
+     * ```typescript
+     * const taxon = await doc.taxonomies.getTaxonByPath(
+     *   "acme/invoice:1.0.0",
+     *   "Invoice/LineItem/Amount"
+     * );
+     * if (taxon) {
+     *   console.log(`Type: ${taxon.taxonType}, Label: ${taxon.label}`);
+     * }
+     * ```
+     */
+    getTaxonByPath(taxonomyRef: string, taxonPath: string): Promise<Taxon | null>;
+    /**
+     * Check if a taxonomy exists in the document
+     *
+     * @param ref The taxonomy reference to check
+     * @returns true if taxonomy exists
+     *
+     * @example
+     * ```typescript
+     * if (await doc.taxonomies.exists("acme/invoice:1.0.0")) {
+     *   // Use the taxonomy for attribute creation
+     * } else {
+     *   // Need to load/store the taxonomy first
+     * }
+     * ```
+     */
+    exists(ref: string): Promise<boolean>;
+    /**
+     * Get all taxon paths from a taxonomy (flattened)
+     *
+     * Useful for populating dropdowns or validating paths.
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @returns Array of all taxon paths in the taxonomy
+     *
+     * @example
+     * ```typescript
+     * const paths = await doc.taxonomies.getAllPaths("acme/invoice:1.0.0");
+     * // ["Invoice", "Invoice/Number", "Invoice/Amount", "Invoice/LineItems", ...]
+     * ```
+     */
+    getAllPaths(taxonomyRef: string): Promise<string[]>;
+    /**
+     * Find taxons by type within a taxonomy
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @param taxonType The taxon type to filter by (e.g., "currency", "date")
+     * @returns Array of matching taxons
+     *
+     * @example
+     * ```typescript
+     * const currencyFields = await doc.taxonomies.findByType(
+     *   "acme/invoice:1.0.0",
+     *   "currency"
+     * );
+     * console.log(`Found ${currencyFields.length} currency fields`);
+     * ```
+     */
+    findByType(taxonomyRef: string, taxonType: string): Promise<Taxon[]>;
+    /**
+     * Find group taxons (containers) within a taxonomy
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @returns Array of group taxons
+     *
+     * @example
+     * ```typescript
+     * const groups = await doc.taxonomies.findGroups("acme/invoice:1.0.0");
+     * for (const group of groups) {
+     *   console.log(`Group: ${group.path} has ${group.children?.length || 0} children`);
+     * }
+     * ```
+     */
+    findGroups(taxonomyRef: string): Promise<Taxon[]>;
+}
+//# sourceMappingURL=TaxonomyAccessor.d.ts.map

package/dist/TaxonomyAccessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaxonomyAccessor.d.ts","sourceRoot":"","sources":["../src/TaxonomyAccessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAGpD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;CACzB;AAED;;;;GAIG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,WAAW,CAAS;gBAEhB,WAAW,EAAE,MAAM;IAI/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC;IAcvD;;;;;;;;;;;;;OAaG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAYrD;;;;;;;;;;;;;OAaG;IACG,MAAM,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAYnC;;;;;;;;;;;;;OAaG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAS3C;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAYnF;;;;;;;;;;;;;;OAcG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK3C;;;;;;;;;;;;;OAaG;IACG,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAkBzD;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAkB1E;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;CAiBxD"}

package/dist/TaxonomyAccessor.js

@@ -0,0 +1,321 @@
+/**
+ * TaxonomyAccessor - Accessor for taxonomies within a KddbDocument
+ *
+ * Provides access to taxonomy definitions stored in the document.
+ * Taxonomies define the structure and types of data that can be extracted,
+ * including taxon paths, data types, validation rules, and metadata.
+ *
+ * Taxonomies are hierarchical structures where each node (taxon) defines
+ * a field type with properties like data type, validation rules, and UI hints.
+ * Storing taxonomies in the document enables automatic taxon resolution
+ * when creating data attributes.
+ *
+ * Usage:
+ * - document.taxonomies.store(taxonomy) - Store a taxonomy definition
+ * - document.taxonomies.getByRef(ref) - Retrieve by reference
+ * - document.taxonomies.getAll() - List all taxonomies
+ * - document.taxonomies.getTaxonByPath(ref, path) - Get specific taxon
+ *
+ * @example
+ * ```typescript
+ * // Store a taxonomy
+ * const taxonomy = await doc.taxonomies.store({
+ *   ref: "acme/invoice:1.0.0",
+ *   name: "Invoice Schema",
+ *   taxons: [{
+ *     name: "Invoice",
+ *     group: true,
+ *     children: [{
+ *       name: "Amount",
+ *       taxonType: "currency",
+ *       path: "Invoice/Amount"
+ *     }]
+ *   }]
+ * });
+ *
+ * // Create an attribute using taxon resolution
+ * const attr = await doc.dataAttributes.create(dataObjectId, {
+ *   taxonomyRef: "acme/invoice:1.0.0",
+ *   taxonPath: "Invoice/Amount",
+ *   decimalValue: 150.00
+ * });
+ * // attr.typeAtCreation is automatically set to "currency"
+ * ```
+ */
+import { getWasmHelper, getWasmInstance } from './wasm/loader';
+/**
+ * TaxonomyAccessor - access taxonomies stored in a document
+ *
+ * This is an internal accessor class. Access via document.taxonomies property.
+ */
+export class TaxonomyAccessor {
+    constructor(documentRef) {
+        this.documentRef = documentRef;
+    }
+    /**
+     * Store or update a taxonomy in the document
+     *
+     * If a taxonomy with the same ref already exists, it will be updated.
+     * The taxon hierarchy paths are automatically computed if not provided.
+     *
+     * @param taxonomy The taxonomy definition to store
+     * @returns The stored taxonomy with assigned ID
+     * @throws Error if storage fails
+     *
+     * @example
+     * ```typescript
+     * const stored = await doc.taxonomies.store({
+     *   ref: "company/schema:1.0.0",
+     *   name: "Company Schema",
+     *   type: "EXTRACTION",
+     *   taxons: [
+     *     {
+     *       name: "Invoice",
+     *       group: true,
+     *       children: [
+     *         { name: "Number", taxonType: "string" },
+     *         { name: "Amount", taxonType: "currency" }
+     *       ]
+     *     }
+     *   ]
+     * });
+     * ```
+     */
+    async store(taxonomy) {
+        await getWasmInstance();
+        const g = globalThis;
+        if (typeof g.documentStoreTaxonomy !== 'function') {
+            throw new Error('documentStoreTaxonomy not available in WASM module');
+        }
+        const resultJson = g.documentStoreTaxonomy(this.documentRef, JSON.stringify(taxonomy));
+        if (!resultJson || resultJson === 'null') {
+            throw new Error('Failed to store taxonomy');
+        }
+        const helper = await getWasmHelper();
+        return helper.parseJsonResult(resultJson);
+    }
+    /**
+     * Get a taxonomy by its reference identifier
+     *
+     * @param ref The taxonomy reference (e.g., "kodexa/invoice:1.0.0")
+     * @returns The taxonomy or null if not found
+     *
+     * @example
+     * ```typescript
+     * const taxonomy = await doc.taxonomies.getByRef("acme/invoice:1.0.0");
+     * if (taxonomy) {
+     *   console.log(`Found: ${taxonomy.name} with ${taxonomy.taxons.length} root taxons`);
+     * }
+     * ```
+     */
+    async getByRef(ref) {
+        await getWasmInstance();
+        const g = globalThis;
+        if (typeof g.documentGetTaxonomy !== 'function') {
+            throw new Error('documentGetTaxonomy not available in WASM module');
+        }
+        const resultJson = g.documentGetTaxonomy(this.documentRef, ref);
+        if (!resultJson || resultJson === 'null')
+            return null;
+        const helper = await getWasmHelper();
+        return helper.parseJsonResult(resultJson);
+    }
+    /**
+     * Get all taxonomies stored in the document
+     *
+     * @returns Array of all taxonomies
+     *
+     * @example
+     * ```typescript
+     * const all = await doc.taxonomies.getAll();
+     * console.log(`Document has ${all.length} taxonomies`);
+     * for (const tax of all) {
+     *   console.log(`- ${tax.ref}: ${tax.name}`);
+     * }
+     * ```
+     */
+    async getAll() {
+        await getWasmInstance();
+        const g = globalThis;
+        if (typeof g.documentGetTaxonomies !== 'function') {
+            throw new Error('documentGetTaxonomies not available in WASM module');
+        }
+        const resultJson = g.documentGetTaxonomies(this.documentRef);
+        const helper = await getWasmHelper();
+        const taxonomies = helper.parseJsonResult(resultJson);
+        return Array.isArray(taxonomies) ? taxonomies : [];
+    }
+    /**
+     * Delete a taxonomy by its reference
+     *
+     * @param ref The taxonomy reference to delete
+     * @returns true if deleted, false if not found
+     *
+     * @example
+     * ```typescript
+     * const deleted = await doc.taxonomies.delete("old/schema:1.0.0");
+     * if (deleted) {
+     *   console.log("Taxonomy removed");
+     * }
+     * ```
+     */
+    async delete(ref) {
+        await getWasmInstance();
+        const g = globalThis;
+        if (typeof g.documentDeleteTaxonomy !== 'function') {
+            throw new Error('documentDeleteTaxonomy not available in WASM module');
+        }
+        return g.documentDeleteTaxonomy(this.documentRef, ref);
+    }
+    /**
+     * Get a specific taxon by path within a taxonomy
+     *
+     * This is useful for looking up taxon metadata like type, label,
+     * or validation rules before creating attributes.
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @param taxonPath The taxon path (e.g., "Invoice/LineItem/Amount")
+     * @returns The taxon or null if not found
+     *
+     * @example
+     * ```typescript
+     * const taxon = await doc.taxonomies.getTaxonByPath(
+     *   "acme/invoice:1.0.0",
+     *   "Invoice/LineItem/Amount"
+     * );
+     * if (taxon) {
+     *   console.log(`Type: ${taxon.taxonType}, Label: ${taxon.label}`);
+     * }
+     * ```
+     */
+    async getTaxonByPath(taxonomyRef, taxonPath) {
+        await getWasmInstance();
+        const g = globalThis;
+        if (typeof g.documentGetTaxonByPath !== 'function') {
+            throw new Error('documentGetTaxonByPath not available in WASM module');
+        }
+        const resultJson = g.documentGetTaxonByPath(this.documentRef, taxonomyRef, taxonPath);
+        if (!resultJson || resultJson === 'null')
+            return null;
+        const helper = await getWasmHelper();
+        return helper.parseJsonResult(resultJson);
+    }
+    /**
+     * Check if a taxonomy exists in the document
+     *
+     * @param ref The taxonomy reference to check
+     * @returns true if taxonomy exists
+     *
+     * @example
+     * ```typescript
+     * if (await doc.taxonomies.exists("acme/invoice:1.0.0")) {
+     *   // Use the taxonomy for attribute creation
+     * } else {
+     *   // Need to load/store the taxonomy first
+     * }
+     * ```
+     */
+    async exists(ref) {
+        const taxonomy = await this.getByRef(ref);
+        return taxonomy !== null;
+    }
+    /**
+     * Get all taxon paths from a taxonomy (flattened)
+     *
+     * Useful for populating dropdowns or validating paths.
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @returns Array of all taxon paths in the taxonomy
+     *
+     * @example
+     * ```typescript
+     * const paths = await doc.taxonomies.getAllPaths("acme/invoice:1.0.0");
+     * // ["Invoice", "Invoice/Number", "Invoice/Amount", "Invoice/LineItems", ...]
+     * ```
+     */
+    async getAllPaths(taxonomyRef) {
+        const taxonomy = await this.getByRef(taxonomyRef);
+        if (!taxonomy)
+            return [];
+        const paths = [];
+        const collectPaths = (taxons) => {
+            if (!taxons)
+                return;
+            for (const taxon of taxons) {
+                if (taxon.path) {
+                    paths.push(taxon.path);
+                }
+                collectPaths(taxon.children);
+            }
+        };
+        collectPaths(taxonomy.taxons);
+        return paths;
+    }
+    /**
+     * Find taxons by type within a taxonomy
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @param taxonType The taxon type to filter by (e.g., "currency", "date")
+     * @returns Array of matching taxons
+     *
+     * @example
+     * ```typescript
+     * const currencyFields = await doc.taxonomies.findByType(
+     *   "acme/invoice:1.0.0",
+     *   "currency"
+     * );
+     * console.log(`Found ${currencyFields.length} currency fields`);
+     * ```
+     */
+    async findByType(taxonomyRef, taxonType) {
+        const taxonomy = await this.getByRef(taxonomyRef);
+        if (!taxonomy)
+            return [];
+        const results = [];
+        const findTaxons = (taxons) => {
+            if (!taxons)
+                return;
+            for (const taxon of taxons) {
+                if (taxon.taxonType === taxonType) {
+                    results.push(taxon);
+                }
+                findTaxons(taxon.children);
+            }
+        };
+        findTaxons(taxonomy.taxons);
+        return results;
+    }
+    /**
+     * Find group taxons (containers) within a taxonomy
+     *
+     * @param taxonomyRef The taxonomy reference
+     * @returns Array of group taxons
+     *
+     * @example
+     * ```typescript
+     * const groups = await doc.taxonomies.findGroups("acme/invoice:1.0.0");
+     * for (const group of groups) {
+     *   console.log(`Group: ${group.path} has ${group.children?.length || 0} children`);
+     * }
+     * ```
+     */
+    async findGroups(taxonomyRef) {
+        const taxonomy = await this.getByRef(taxonomyRef);
+        if (!taxonomy)
+            return [];
+        const results = [];
+        const findGroups = (taxons) => {
+            if (!taxons)
+                return;
+            for (const taxon of taxons) {
+                if (taxon.group) {
+                    results.push(taxon);
+                }
+                findGroups(taxon.children);
+            }
+        };
+        findGroups(taxonomy.taxons);
+        return results;
+    }
+}
+//# sourceMappingURL=TaxonomyAccessor.js.map

package/dist/TaxonomyAccessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TaxonomyAccessor.js","sourceRoot":"","sources":["../src/TaxonomyAccessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAGH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAoL/D;;;;GAIG;AACH,MAAM,OAAO,gBAAgB;IAG3B,YAAY,WAAmB;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,KAAK,CAAC,QAAuB;QACjC,MAAM,eAAe,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,UAAiB,CAAC;QAC5B,IAAI,OAAO,CAAC,CAAC,qBAAqB,KAAK,UAAU,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,UAAU,GAAG,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,aAAa,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW;QACxB,MAAM,eAAe,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,UAAiB,CAAC;QAC5B,IAAI,OAAO,CAAC,CAAC,mBAAmB,KAAK,UAAU,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,UAAU,GAAG,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,aAAa,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,eAAe,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,UAAiB,CAAC;QAC5B,IAAI,OAAO,CAAC,CAAC,qBAAqB,KAAK,UAAU,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;QACxE,CAAC;QACD,MAAM,UAAU,GAAG,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7D,MAAM,MAAM,GAAG,MAAM,aAAa,EAAE,CAAC;QACrC,MAAM,UAAU,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QACtD,OAAO,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,eAAe,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,UAAiB,CAAC;QAC5B,IAAI,OAAO,CAAC,CAAC,sBAAsB,KAAK,UAAU,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,cAAc,CAAC,WAAmB,EAAE,SAAiB;QACzD,MAAM,eAAe,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,UAAiB,CAAC;QAC5B,IAAI,OAAO,CAAC,CAAC,sBAAsB,KAAK,UAAU,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,UAAU,GAAG,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;QACtF,IAAI,CAAC,UAAU,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,IAAI,CAAC;QACtD,MAAM,MAAM,GAAG,MAAM,aAAa,EAAE,CAAC;QACrC,OAAO,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,OAAO,QAAQ,KAAK,IAAI,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,WAAW,CAAC,WAAmB;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAG,CAAC,MAA2B,EAAQ,EAAE;YACzD,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;oBACf,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzB,CAAC;gBACD,YAAY,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC,CAAC;QACF,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,SAAiB;QACrD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,MAAM,OAAO,GAAY,EAAE,CAAC;QAC5B,MAAM,UAAU,GAAG,CAAC,MAA2B,EAAQ,EAAE;YACvD,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;oBAClC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;gBACD,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC;QACF,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,UAAU,CAAC,WAAmB;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QAEzB,MAAM,OAAO,GAAY,EAAE,CAAC;QAC5B,MAAM,UAAU,GAAG,CAAC,MAA2B,EAAQ,EAAE;YACvD,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;oBAChB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACtB,CAAC;gBACD,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC;QACF,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;CACF"}