@stonecrop/stonecrop 0.3.5 → 0.3.7

package/dist/stonecrop.js

@@ -16,31 +16,31 @@ ut.prototype = Object.create(Error.prototype, {
 });
 const we = class we {
   /**
-   * @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, r, o, s) {
     /**
-     * @property {string} name
-     * @description The name of the Stonecrop instance
-     * @example
-     * 'Stonecrop'
+     * The name of the Stonecrop instance
+     * @readonly
+     *
+     * @defaultValue 'Stonecrop'
      */
     x(this, "name", "Stonecrop");
     /**
-     * @property {Registry} registry
-     * @description The registry is an immutable collection of doctypes
+     * The registry is an immutable collection of doctypes
      * @example
+     * ```ts
      * {
      * 	'task': {
      * 		doctype: 'Task',
@@ -52,14 +52,15 @@ const we = class we {
      * 	},
      * 	...
      * }
+     * ```
      * @see {@link Registry}
      * @see {@link DoctypeMeta}
      */
     x(this, "registry");
     /**
-     * @property {Schema} schema - The Stonecrop schema
-     * @description The schema is a subset of the registry
+     * schema - The Stonecrop schema; the schema is a subset of the registry
      * @example
+     * ```ts
      * {
      * 	doctype: 'Task',
      * 	schema: {
@@ -68,24 +69,22 @@ const we = class we {
      * 		...
      * 	}
      * }
+     * ```
      * @see {@link Registry}
      * @see {@link DoctypeMeta}
      * @see {@link DoctypeMeta.schema}
      */
     x(this, "schema");
     /**
-     * @property {ImmutableDoctype['workflow']} workflow
-     * @description The workflow is a subset of the registry
+     * The workflow is a subset of the registry
      */
     x(this, "workflow");
     /**
-     * @property {ImmutableDoctype['actions']} actions
-     * @description The actions are a subset of the registry
+     * The actions are a subset of the registry
      */
     x(this, "actions");
     /**
-     * @property {ReturnType<typeof useDataStore>} store
-     * @description The Pinia store that manages the mutable records
+     * The Pinia store that manages the mutable records
      */
     x(this, "store");
     if (we._root)
@@ -93,70 +92,73 @@ const we = class we {
     we._root = this, this.registry = t, this.store = n, this.schema = r, this.workflow = o, 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 ut(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: [] });
@@ -164,14 +166,14 @@ const we = class we {
     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: {} });
@@ -179,24 +181,30 @@ const we = class we {
     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, r) {
     const s = this.registry.registry[t.slug].actions.get(n), { initialState: i } = this.workflow;
@@ -206,8 +214,7 @@ const we = class we {
   }
 };
 /**
- * @property {Stonecrop} _root
- * @description The root Stonecrop instance
+ * The root Stonecrop instance
  */
 x(we, "_root");
 let lt = we;
@@ -1190,33 +1197,83 @@ function Mi(e) {
   }), { stonecrop: n, isReady: r };
 }
 class Vi {
+  // TODO: allow different components for different views; probably
+  // should be defined in the schema instead?
   constructor(t, n, r, o, s) {
+    /**
+     * The doctype name
+     * @public
+     * @readonly
+     */
     x(this, "doctype");
+    /**
+     * The doctype schema
+     * @public
+     * @readonly
+     */
     x(this, "schema");
+    /**
+     * The doctype workflow
+     * @public
+     * @readonly
+     */
     x(this, "workflow");
+    /**
+     * The doctype actions
+     * @public
+     * @readonly
+     */
     x(this, "actions");
-    // TODO: allow different components for different views; probably
-    // should be defined in the schema instead?
+    /**
+     * The doctype component
+     * @public
+     * @readonly
+     */
     x(this, "component");
     this.doctype = t, this.schema = n, this.workflow = r, this.actions = o, this.component = s;
   }
+  /**
+   * Converts the registered doctype to a slug (kebab-case)
+   * @returns The slugified doctype string
+   * @public
+   */
   get slug() {
     return this.doctype.replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[\s_]+/g, "-").toLowerCase();
   }
-  get __typename() {
-    return this.doctype;
-  }
 }
 const Se = class Se {
   constructor(t, n) {
+    /**
+     * The name of the Registry instance
+     *
+     * @defaultValue 'Registry'
+     */
     x(this, "name");
+    /**
+     * The Vue router instance
+     * @see {@link https://router.vuejs.org/}
+     */
     x(this, "router");
+    /**
+     * The registry property contains a collection of doctypes
+     * @see {@link DoctypeMeta}
+     */
     x(this, "registry");
+    /**
+     * The getMeta function fetches doctype metadata from an API
+     * @see {@link DoctypeMeta}
+     */
     x(this, "getMeta");
     if (Se._root)
       return Se._root;
     Se._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}`,
@@ -1225,6 +1282,9 @@ const Se = class Se {
     });
   }
 };
+/**
+ * The root Registry instance
+ */
 x(Se, "_root");
 let pt = Se;
 /*!