@stonecrop/stonecrop 0.3.4 → 0.3.6

package/dist/composable.js

@@ -1,11 +1,24 @@
 import { inject, onBeforeMount, ref } from 'vue';
 import { Stonecrop } from './stonecrop';
 import { useDataStore } from './stores/data';
+/**
+ * Stonecrop composable
+ * @param registry - An existing Stonecrop Registry instance
+ * @returns The Stonecrop instance and a boolean indicating if Stonecrop is setup and ready
+ * @throws Error if the Stonecrop plugin is not enabled before using the composable
+ * @public
+ */
 export function useStonecrop(registry) {
     if (!registry) {
         registry = inject('$registry');
     }
-    const store = useDataStore();
+    let store;
+    try {
+        store = useDataStore();
+    }
+    catch (e) {
+        throw new Error('Please enable the Stonecrop plugin before using the Stonecrop composable');
+    }
     const stonecrop = ref(new Stonecrop(registry, store));
     const isReady = ref(false);
     onBeforeMount(async () => {

package/dist/doctype.js

@@ -1,11 +1,40 @@
+/**
+ * Doctype Meta class
+ * @public
+ */
 export default class DoctypeMeta {
+    /**
+     * The doctype name
+     * @public
+     * @readonly
+     */
     doctype;
+    /**
+     * The doctype schema
+     * @public
+     * @readonly
+     */
     schema;
+    /**
+     * The doctype workflow
+     * @public
+     * @readonly
+     */
     workflow;
+    /**
+     * The doctype actions
+     * @public
+     * @readonly
+     */
     actions;
+    /**
+     * The doctype component
+     * @public
+     * @readonly
+     */
+    component;
     // TODO: allow different components for different views; probably
     // should be defined in the schema instead?
-    component;
     constructor(doctype, schema, workflow, actions, component) {
         this.doctype = doctype;
         this.schema = schema;
@@ -13,14 +42,15 @@ export default class DoctypeMeta {
         this.actions = actions;
         this.component = component;
     }
+    /**
+     * Converts the registered doctype to a slug (kebab-case)
+     * @returns The slugified doctype string
+     * @public
+     */
     get slug() {
-        // kebab case
         return this.doctype
             .replace(/([a-z])([A-Z])/g, '$1-$2')
             .replace(/[\s_]+/g, '-')
             .toLowerCase();
     }
-    get __typename() {
-        return this.doctype;
-    }
 }

package/dist/plugins/index.js

@@ -1,6 +1,34 @@
 import Registry from '../registry';
 import router from '../router';
 import { pinia } from '../stores';
+/**
+ * Stonecrop Vue plugin
+ * @param app - The Vue app instance
+ * @param options - The plugin options
+ * @example
+ * ```ts
+ *
+ * import { createApp } from 'vue'
+ * import Stonecrop from 'stonecrop'
+ *
+ * import App from './App.vue'
+ *
+ * const app = createApp(App)
+ * app.use(Stonecrop, {
+ *  router,
+ *  components: {
+ *   // register custom components
+ *  },
+ *  getMeta: async (doctype: string) => {
+ *   // fetch doctype meta from API
+ *  },
+ * })
+ *
+ * app.mount('#app')
+ * ```
+ *
+ * @public
+ */
 const plugin = {
     install: (app, options) => {
         const appRouter = options?.router || router;

package/dist/registry.js

@@ -1,8 +1,32 @@
+/**
+ * Stonecrop Registry class
+ * @public
+ */
 export default class Registry {
+    /**
+     * The root Registry instance
+     */
     static _root;
+    /**
+     * The name of the Registry instance
+     *
+     * @defaultValue 'Registry'
+     */
     name;
+    /**
+     * The Vue router instance
+     * @see {@link https://router.vuejs.org/}
+     */
     router;
+    /**
+     * The registry property contains a collection of doctypes
+     * @see {@link DoctypeMeta}
+     */
     registry;
+    /**
+     * The getMeta function fetches doctype metadata from an API
+     * @see {@link DoctypeMeta}
+     */
     getMeta;
     constructor(router, getMeta) {
         if (Registry._root) {
@@ -14,6 +38,12 @@ export default class Registry {
         this.registry = {};
         this.getMeta = getMeta;
     }
+    /**
+     * Get doctype metadata
+     * @param doctype - The doctype to fetch metadata for
+     * @returns The doctype metadata
+     * @see {@link DoctypeMeta}
+     */
     addDoctype(doctype) {
         if (!(doctype.doctype in Object.keys(this.registry))) {
             this.registry[doctype.slug] = doctype;

package/dist/src/composable.d.ts

@@ -1,10 +1,20 @@
 import { Ref } from 'vue';
 import Registry from './registry';
 import { Stonecrop } from './stonecrop';
-type StonecropReturn = {
+/**
+ * Stonecrop composable return type
+ * @public
+ */
+export type StonecropReturn = {
     stonecrop: Ref<Stonecrop>;
     isReady: Ref<boolean>;
 };
+/**
+ * Stonecrop composable
+ * @param registry - An existing Stonecrop Registry instance
+ * @returns The Stonecrop instance and a boolean indicating if Stonecrop is setup and ready
+ * @throws Error if the Stonecrop plugin is not enabled before using the composable
+ * @public
+ */
 export declare function useStonecrop(registry?: Registry): StonecropReturn;
-export {};
 //# sourceMappingURL=composable.d.ts.map

package/dist/src/composable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,GAAG,EAAO,MAAM,KAAK,CAAA;AAErD,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,KAAK,eAAe,GAAG;IACtB,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACzB,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACrB,CAAA;AAED,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,eAAe,CAsCjE"}
+{"version":3,"file":"composable.d.ts","sourceRoot":"","sources":["../../src/composable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,GAAG,EAAO,MAAM,KAAK,CAAA;AAErD,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC7B,SAAS,EAAE,GAAG,CAAC,SAAS,CAAC,CAAA;IACzB,OAAO,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CACrB,CAAA;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,eAAe,CA4CjE"}

package/dist/src/doctype.d.ts

@@ -1,13 +1,46 @@
 import { Component } from 'vue';
 import type { ImmutableDoctype } from './types';
+/**
+ * Doctype Meta class
+ * @public
+ */
 export default class DoctypeMeta {
+    /**
+     * The doctype name
+     * @public
+     * @readonly
+     */
     readonly doctype: string;
+    /**
+     * The doctype schema
+     * @public
+     * @readonly
+     */
     readonly schema: ImmutableDoctype['schema'];
+    /**
+     * The doctype workflow
+     * @public
+     * @readonly
+     */
     readonly workflow: ImmutableDoctype['workflow'];
+    /**
+     * The doctype actions
+     * @public
+     * @readonly
+     */
     readonly actions: ImmutableDoctype['actions'];
+    /**
+     * The doctype component
+     * @public
+     * @readonly
+     */
     readonly component?: Component;
     constructor(doctype: string, schema: ImmutableDoctype['schema'], workflow: ImmutableDoctype['workflow'], actions: ImmutableDoctype['actions'], component?: Component);
+    /**
+     * Converts the registered doctype to a slug (kebab-case)
+     * @returns The slugified doctype string
+     * @public
+     */
     get slug(): string;
-    get __typename(): string;
 }
 //# sourceMappingURL=doctype.d.ts.map

package/dist/src/doctype.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"doctype.d.ts","sourceRoot":"","sources":["../../src/doctype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC3C,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAC/C,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAG7C,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;gBAG7B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACtC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS;IAStB,IAAI,IAAI,WAMP;IAED,IAAI,UAAU,WAEb;CACD"}
+{"version":3,"file":"doctype.d.ts","sourceRoot":"","sources":["../../src/doctype.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAE3C;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAE/C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAE7C;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAA;gBAK7B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,gBAAgB,CAAC,QAAQ,CAAC,EAClC,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACtC,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,EACpC,SAAS,CAAC,EAAE,SAAS;IAStB;;;;OAIG;IACH,IAAI,IAAI,WAKP;CACD"}

package/dist/src/index.d.ts

@@ -1,7 +1,9 @@
-import { useStonecrop } from './composable';
+export type { BaseSchema, FieldsetSchema, FormSchema, SchemaTypes, TableSchema } from '@stonecrop/aform';
+export type { CellContext, TableColumn, TableConfig, TableRow } from '@stonecrop/atable';
+import { type StonecropReturn, useStonecrop } from './composable';
 import DoctypeMeta from './doctype';
 import Registry from './registry';
 import Stonecrop from './plugins';
 export type { ImmutableDoctype, MutableDoctype, Schema, InstallOptions } from './types';
-export { DoctypeMeta, Registry, Stonecrop, useStonecrop };
+export { DoctypeMeta, Registry, Stonecrop, StonecropReturn, useStonecrop };
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACxG,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAExF,OAAO,EAAE,KAAK,eAAe,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AACjE,OAAO,WAAW,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,SAAS,MAAM,WAAW,CAAA;AACjC,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAEvF,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,YAAY,EAAE,CAAA"}

package/dist/src/plugins/index.d.ts

@@ -1,4 +1,32 @@
 import { type Plugin } from 'vue';
+/**
+ * Stonecrop Vue plugin
+ * @param app - The Vue app instance
+ * @param options - The plugin options
+ * @example
+ * ```ts
+ *
+ * import { createApp } from 'vue'
+ * import Stonecrop from 'stonecrop'
+ *
+ * import App from './App.vue'
+ *
+ * const app = createApp(App)
+ * app.use(Stonecrop, {
+ *  router,
+ *  components: {
+ *   // register custom components
+ *  },
+ *  getMeta: async (doctype: string) => {
+ *   // fetch doctype meta from API
+ *  },
+ * })
+ *
+ * app.mount('#app')
+ * ```
+ *
+ * @public
+ */
 declare const plugin: Plugin;
 export default plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/src/plugins/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,KAAK,CAAA;AAOtC,QAAA,MAAM,MAAM,EAAE,MAeb,CAAA;AAED,eAAe,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,KAAK,MAAM,EAAE,MAAM,KAAK,CAAA;AAOtC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,QAAA,MAAM,MAAM,EAAE,MAeb,CAAA;AAED,eAAe,MAAM,CAAA"}

package/dist/src/registry.d.ts

@@ -1,12 +1,42 @@
 import { Router } from 'vue-router';
 import DoctypeMeta from './doctype';
+/**
+ * Stonecrop Registry class
+ * @public
+ */
 export default class Registry {
+    /**
+     * The root Registry instance
+     */
     static _root: Registry;
+    /**
+     * The name of the Registry instance
+     *
+     * @defaultValue 'Registry'
+     */
     name: string;
+    /**
+     * The Vue router instance
+     * @see {@link https://router.vuejs.org/}
+     */
     router: Router;
+    /**
+     * The registry property contains a collection of doctypes
+     * @see {@link DoctypeMeta}
+     */
     registry: Record<string, DoctypeMeta>;
+    /**
+     * The getMeta function fetches doctype metadata from an API
+     * @see {@link DoctypeMeta}
+     */
     getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>;
     constructor(router: Router, getMeta?: (doctype: string) => DoctypeMeta | Promise<DoctypeMeta>);
+    /**
+     * Get doctype metadata
+     * @param doctype - The doctype to fetch metadata for
+     * @returns The doctype metadata
+     * @see {@link DoctypeMeta}
+     */
     addDoctype(doctype: DoctypeMeta): void;
 }
 //# sourceMappingURL=registry.d.ts.map

package/dist/src/registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IACrC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;gBAErD,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAW7F,UAAU,CAAC,OAAO,EAAE,WAAW;CAY/B"}
+{"version":3,"file":"registry.d.ts","sourceRoot":"","sources":["../../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnC,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC5B;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAA;IAEtB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAErC;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;gBAErD,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAW7F;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW;CAY/B"}

package/dist/src/stonecrop.d.ts

@@ -2,23 +2,26 @@ import DoctypeMeta from './doctype';
 import Registry from './registry';
 import { useDataStore } from './stores/data';
 import type { ImmutableDoctype, Schema } from './types';
+/**
+ * Stonecrop class
+ * @public
+ */
 export declare class Stonecrop {
     /**
-     * @property {Stonecrop} _root
-     * @description The root Stonecrop instance
+     * The root Stonecrop instance
      */
     static _root: Stonecrop;
     /**
-     * @property {string} name
-     * @description The name of the Stonecrop instance
-     * @example
-     * 'Stonecrop'
+     * The name of the Stonecrop instance
+     * @readonly
+     *
+     * @defaultValue 'Stonecrop'
      */
     readonly 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',
@@ -30,14 +33,15 @@ export declare class Stonecrop {
      * 	},
      * 	...
      * }
+     * ```
      * @see {@link Registry}
      * @see {@link DoctypeMeta}
      */
     readonly registry: 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: {
@@ -46,128 +50,135 @@ export declare class Stonecrop {
      * 		...
      * 	}
      * }
+     * ```
      * @see {@link Registry}
      * @see {@link DoctypeMeta}
      * @see {@link DoctypeMeta.schema}
      */
     schema: Schema;
     /**
-     * @property {ImmutableDoctype['workflow']} workflow
-     * @description The workflow is a subset of the registry
+     * The workflow is a subset of the registry
      */
     workflow: ImmutableDoctype['workflow'];
     /**
-     * @property {ImmutableDoctype['actions']} actions
-     * @description The actions are a subset of the registry
+     * The actions are a subset of the registry
      */
     actions: ImmutableDoctype['actions'];
     /**
-     * @property {ReturnType<typeof useDataStore>} store
-     * @description The Pinia store that manages the mutable records
+     * The Pinia store that manages the mutable records
      */
     store: ReturnType<typeof useDataStore>;
     /**
-     * @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(registry: Registry, store: ReturnType<typeof useDataStore>, schema?: Schema, workflow?: ImmutableDoctype['workflow'], actions?: ImmutableDoctype['actions']);
     /**
-     * @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(doctype: DoctypeMeta): void;
     /**
-     * @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(doctype: DoctypeMeta): DoctypeMeta | Promise<DoctypeMeta> | never;
     /**
-     * @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(doctype: DoctypeMeta): void;
     /**
-     * @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(doctype: DoctypeMeta): void;
     /**
-     * @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 })
+     * ```
      */
     getRecords(doctype: DoctypeMeta, filters?: RequestInit): Promise<void>;
     /**
-     * @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')
+     * ```
      */
     getRecord(doctype: DoctypeMeta, id: string): Promise<void>;
     /**
-     * @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(doctype: DoctypeMeta, action: string, id?: string[]): void;
 }

package/dist/src/stonecrop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../src/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEvD,qBAAa,SAAS;IACrB;;;OAGG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,CAAA;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,eAAc;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAEtC;;;OAGG;IACH,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAEpC;;;OAGG;IACH,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAA;IAEtC;;;;;;;;;;;;;OAaG;gBAEF,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,EACtC,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACvC,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAatC;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAMjC;;;;;;;;;;OAUG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK;IAIzE;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKvC;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKtC;;;;;;;;;;;;;OAaG;IACG,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5E;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhE;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;CAiBpE"}
+{"version":3,"file":"stonecrop.d.ts","sourceRoot":"","sources":["../../src/stonecrop.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,WAAW,CAAA;AAEnC,OAAO,QAAQ,MAAM,YAAY,CAAA;AACjC,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAEvD;;;GAGG;AACH,qBAAa,SAAS;IACrB;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,SAAS,CAAA;IAEvB;;;;;OAKG;IACH,QAAQ,CAAC,IAAI,eAAc;IAE3B;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;IAE3B;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC,UAAU,CAAC,CAAA;IAEtC;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAA;IAEpC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,CAAA;IAEtC;;;;;;;;;;;;;OAaG;gBAEF,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,EACtC,MAAM,CAAC,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,gBAAgB,CAAC,UAAU,CAAC,EACvC,OAAO,CAAC,EAAE,gBAAgB,CAAC,SAAS,CAAC;IAatC;;;;;;;;OAQG;IACH,KAAK,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAMjC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,KAAK;IAIzE;;;;;;;;OAQG;IACH,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKvC;;;;;;;;OAQG;IACH,UAAU,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAKtC;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5E;;;;;;;;;OASG;IACG,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOhE;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI;CAiBpE"}

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.48.0"
+    }
+  ]
+}

package/dist/src/types/index.d.ts

@@ -4,20 +4,36 @@ import { Component } from 'vue';
 import { Router } from 'vue-router';
 import { MachineConfig, StateMachine } from 'xstate';
 import DoctypeMeta from '../doctype';
+/**
+ * Immutable Doctype type for Stonecrop instances
+ * @public
+ */
 export type ImmutableDoctype = {
     readonly schema?: List<SchemaTypes>;
     readonly workflow: StateMachine<unknown, unknown, any>;
     readonly actions?: Map<string, string[]>;
 };
+/**
+ * Mutable Doctype type for Stonecrop instances
+ * @public
+ */
 export type MutableDoctype = {
     schema?: SchemaTypes[];
     workflow: MachineConfig<unknown, unknown, any>;
     actions?: Record<string, string[]>;
 };
+/**
+ * Schema type for Stonecrop instances
+ * @public
+ */
 export type Schema = {
     doctype: string;
     schema: List<SchemaTypes>;
 };
+/**
+ * Install options for Stonecrop Vue plugin
+ * @public
+ */
 export type InstallOptions = {
     router?: Router;
     components?: Record<string, Component>;

package/dist/src/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAEpD,OAAO,WAAW,MAAM,YAAY,CAAA;AAEpC,MAAM,MAAM,gBAAgB,GAAG;IAE9B,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;IACtD,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAE5B,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;CACzB,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAClE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAA;AAC/B,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAA;AAEpD,OAAO,WAAW,MAAM,YAAY,CAAA;AAEpC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAE9B,QAAQ,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACnC,QAAQ,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;IACtD,QAAQ,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CACxC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAE5B,MAAM,CAAC,EAAE,WAAW,EAAE,CAAA;IACtB,QAAQ,EAAE,aAAa,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAClC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACtC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;CAClE,CAAA"}