@stonecrop/desktop 0.3.5 → 0.3.7

package/dist/desktop.d.ts

@@ -5,19 +5,59 @@ import { Plugin as Plugin_2 } from 'vue';
 import Records from './components/Records.vue';
 import SheetNav from './components/SheetNav.vue';
 
+/**
+ * Superset of all element types in the Action Set
+ * @public
+ */
+export declare type ActionElements = ButtonElement | DropdownElement;
+
 export { ActionSet }
 
+/**
+ * Base type for elements in the Action Set
+ * @public
+ */
+export declare type BaseElement = {
+    label: string;
+    show?: boolean;
+};
+
+/**
+ * Button elements
+ * @public
+ */
+export declare type ButtonElement = BaseElement & ElementAction & {
+    type: 'button';
+};
+
 export { CommandPalette }
 
 export { Doctype }
 
+/**
+ * Dropdown elements
+ * @public
+ */
+export declare type DropdownElement = BaseElement & {
+    type: 'dropdown';
+    actions: ElementAction[];
+};
+
+/**
+ * Element actions
+ * @public
+ */
+export declare type ElementAction = BaseElement & {
+    link?: string;
+    action?: () => void;
+};
+
 export { Records }
 
 export { SheetNav }
 
 /**
- * This is the main plugin file that will be used to register all the components
- * that we want to use in our application.
+ * This is the main plugin that will be used to register all the desktop components.
  * @public
  */
 export declare const StonecropDesktop: Plugin_2;

package/dist/desktop.js

@@ -11,7 +11,7 @@ const es = { class: "action-menu-icon" }, ts = ["onclick"], ns = { key: 1 }, os
     });
     const a = () => {
       for (const d of t.value)
-        d.elementType === "dropdown" && (d.show = !1);
+        d.type === "dropdown" && (d.show = !1);
     }, i = () => {
       r.value = !0, o.value = setTimeout(() => {
         r.value && (n.value = !0);
@@ -69,12 +69,12 @@ const es = { class: "action-menu-icon" }, ts = ["onclick"], ns = { key: 1 }, os
         class: "action-element",
         key: p.label
       }, [
-        p.elementType == "button" ? (A(), B("button", {
+        p.type == "button" ? (A(), B("button", {
           key: 0,
           onclick: p.action,
           class: "button-default"
         }, ve(p.label), 9, ts)) : ge("", !0),
-        p.elementType == "dropdown" ? (A(), B("div", ns, [
+        p.type == "dropdown" ? (A(), B("div", ns, [
           W("button", {
             class: "button-default",
             onClick: (h) => c(f)
@@ -108,7 +108,7 @@ const es = { class: "action-menu-icon" }, ts = ["onclick"], ns = { key: 1 }, os
   for (const [o, r] of t)
     n[o] = r;
   return n;
-}, us = /* @__PURE__ */ En(ls, [["__scopeId", "data-v-4fb5c934"]]), ds = {};
+}, us = /* @__PURE__ */ En(ls, [["__scopeId", "data-v-38e7af34"]]), ds = {};
 function ps(e, t) {
   return A(), B("dialog");
 }
@@ -174,18 +174,18 @@ on.prototype = Object.create(Error.prototype, {
 });
 const Mo = class kt {
   /**
-   * @constructor
-   * @param {Registry} registry - The immutable registry
-   * @param {ReturnType<typeof useDataStore>} store - The mutable Pinia store
-   * @param {Schema} [schema] - (optional) The Stonecrop schema
-   * @param {ImmutableDoctype['workflow']} [workflow] - (optional) The Stonecrop workflow
-   * @param {ImmutableDoctype['actions']} [actions] - (optional) The Stonecrop actions
-   * @returns {Stonecrop} The Stonecrop instance
-   * @description The Stonecrop constructor initializes a new Stonecrop instance with the given registry, store, schema, workflow, and actions. If a Stonecrop instance has already been created, it returns the existing instance instead of creating a new one.
+   * @param registry - The immutable registry
+   * @param store - The mutable Pinia store
+   * @param schema - The Stonecrop schema
+   * @param workflow - The Stonecrop workflow
+   * @param actions - The Stonecrop actions
+   * @returns The Stonecrop instance with the given registry, store, schema, workflow, and actions. If a Stonecrop instance has already been created, it returns the existing instance instead of creating a new one.
    * @example
+   * ```ts
    * const registry = new Registry()
    * const store = useDataStore()
-   * const stonecrop = new Stonecrop(registry, store, schema, workflow, actions)
+   * const stonecrop = new Stonecrop(registry, store)
+   * ```
    */
   constructor(t, n, o, r, s) {
     if (oe(this, "name", "Stonecrop"), oe(this, "registry"), oe(this, "schema"), oe(this, "workflow"), oe(this, "actions"), oe(this, "store"), kt._root)
@@ -193,70 +193,73 @@ const Mo = class kt {
     kt._root = this, this.registry = t, this.store = n, this.schema = o, this.workflow = r, this.actions = s;
   }
   /**
-   * @method setup
-   * @param {DoctypeMeta} doctype - The doctype to setup
-   * @returns {void}
-   * @description Sets up the Stonecrop instance with the given doctype
+   * Sets up the Stonecrop instance with the given doctype
+   * @param doctype - The doctype to setup
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.setup(doctype)
+   * ```
    */
   setup(t) {
     this.getMeta(t), this.getWorkflow(t), this.getActions(t);
   }
   /**
-   * @method getMeta
-   * @param {DoctypeMeta} doctype - The doctype to get meta for
-   * @returns {DoctypeMeta}
-   * @see {@link DoctypeMeta}
+   * Gets the meta for the given doctype
+   * @param doctype - The doctype to get meta for
+   * @returns The meta for the given doctype
    * @throws NotImplementedError
-   * @description Gets the meta for the given doctype
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * const meta = stonecrop.getMeta(doctype)
+   * ```
+   * @see {@link DoctypeMeta}
    */
   getMeta(t) {
     return this.registry.getMeta ? this.registry.getMeta(t.doctype) : new on(t.doctype);
   }
   /**
-   * @method getWorkflow
-   * @param {DoctypeMeta} doctype - The doctype to get workflow for
-   * @returns {void}
-   * @description Gets the workflow for the given doctype
+   * Gets the workflow for the given doctype
+   * @param doctype - The doctype to get workflow for
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.getWorkflow(doctype)
+   * ```
    */
   getWorkflow(t) {
     const n = this.registry.registry[t.slug];
     this.workflow = n.workflow;
   }
   /**
-   * @method getActions
-   * @param {DoctypeMeta} doctype - The doctype to get actions for
-   * @returns {void}
-   * @description Gets the actions for the given doctype
+   * Gets the actions for the given doctype
+   * @param doctype - The doctype to get actions for
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.getActions(doctype)
+   * ```
    */
   getActions(t) {
     const n = this.registry.registry[t.slug];
     this.actions = n.actions;
   }
   /**
-   * @method getRecords
-   * @param {DoctypeMeta} doctype - The doctype to get records for
-   * @param {RequestInit} [filters] - The filters to apply to the records
-   * @returns {Promise<void>}
-   * @description Gets the records for the given doctype
+   * Gets the records for the given doctype
+   * @param doctype - The doctype to get records for
+   * @param filters - The filters to apply to the records
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * await stonecrop.getRecords(doctype)
+   * ```
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * const filters = JSON.stringify({ status: 'Open' })
    * await stonecrop.getRecords(doctype, { body: filters })
+   * ```
    */
   async getRecords(t, n) {
     this.store.$patch({ records: [] });
@@ -264,14 +267,14 @@ const Mo = class kt {
     this.store.$patch({ records: o });
   }
   /**
-   * @method getRecord
-   * @param {DoctypeMeta} doctype - The doctype to get record for
-   * @param {string} id - The id of the record to get
-   * @returns {Promise<void>}
-   * @description Gets the record for the given doctype and id
+   * Gets the record for the given doctype and id
+   * @param doctype - The doctype to get record for
+   * @param id - The id of the record to get
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * await stonecrop.getRecord(doctype, 'TASK-00001')
+   * ```
    */
   async getRecord(t, n) {
     this.store.$patch({ record: {} });
@@ -279,24 +282,30 @@ const Mo = class kt {
     this.store.$patch({ record: o });
   }
   /**
-   * @method runAction
-   * @param {DoctypeMeta} doctype - The doctype to run action for
-   * @param {string} action - The action to run
-   * @param {string[]} [id] - The id(s) of the record(s) to run action on
-   * @returns {void}
-   * @description Runs the action for the given doctype and id
+   * Runs the action for the given doctype and id
+   * @param doctype - The doctype to run action for
+   * @param action - The action to run
+   * @param id - The id(s) of the record(s) to run action on
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.runAction(doctype, 'CREATE')
+   * ```
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.runAction(doctype, 'UPDATE', ['TASK-00001'])
+   * ```
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.runAction(doctype, 'DELETE', ['TASK-00001'])
+   * ```
    * @example
+   * ```ts
    * const doctype = await registry.getMeta('Task')
    * stonecrop.runAction(doctype, 'TRANSITION', ['TASK-00001', 'TASK-00002'])
+   * ```
    */
   runAction(t, n, o) {
     const r = this.registry.registry[t.slug].actions.get(n), { initialState: s } = this.workflow;
@@ -1291,6 +1300,12 @@ const Ks = class St {
       return St._root;
     St._root = this, this.name = "Registry", this.router = t, this.registry = {}, this.getMeta = n;
   }
+  /**
+   * Get doctype metadata
+   * @param doctype - The doctype to fetch metadata for
+   * @returns The doctype metadata
+   * @see {@link DoctypeMeta}
+   */
   addDoctype(t) {
     t.doctype in Object.keys(this.registry) || (this.registry[t.slug] = t), this.router.hasRoute(t.doctype) || this.router.addRoute({
       path: `/${t.slug}`,