@cortezaproject/corteza-vue 2024.9.4 → 2024.9.5-dev.2

package/dist/node_modules/@tiptap/pm/state/index.d.ts

@@ -0,0 +1 @@
+export * from 'prosemirror-state';

package/dist/src/components/auth/index.d.ts

@@ -0,0 +1 @@
+export { default as CExtendSession } from './CExtendSession.vue';

package/dist/src/components/c3/Controls/index.d.ts

@@ -0,0 +1,22 @@
+import { Component } from 'vue';
+interface Handler {
+    value(props: object): unknown;
+    update(props: object, value: unknown): void;
+}
+interface Props {
+    [_: string]: unknown;
+}
+interface Control extends Handler {
+    component: Component;
+    props?: Props;
+}
+interface Specs {
+    handler: string | Handler;
+    props?: Props;
+}
+export declare function generic(component: Component, { handler, props }: Specs): Control;
+export declare function input(label: string, handler: string | Handler): Control;
+export declare function textarea(label: string, handler: string | Handler): Control;
+export declare function checkbox(label: string, handler: string | Handler): Control;
+export declare function select(label: string, handler: string | Handler, options: object): Control;
+export {};

package/dist/src/components/c3/helpers.d.ts

@@ -0,0 +1,29 @@
+export interface CatalogueItem {
+    group?: Array<string>;
+    name?: string;
+}
+export interface Catalogue {
+    [_: string]: CatalogueItem;
+}
+/**
+ * Extract subgroups from the given groups
+ * @param groups
+ * @param path Array of groups that represent the path
+ */
+export declare function extractGroups(groups: Array<Array<string>>, ...path: Array<string>): Array<string>;
+/**
+ * Extract subgroups from the catalogue that match the given path
+ *
+ * @param cat Catalogue
+ * @param path Array of groups that represent the path
+ * @constructor
+ */
+export declare function ExtractSubgroups(cat: Catalogue, ...path: Array<string>): Array<string>;
+/**
+ * Returns all components that match the given path
+ *
+ * @param cat Catalogue
+ * @param path Array of groups that represent the path
+
+ */
+export declare function ExtractComponents(cat: Catalogue, ...path: Array<string>): Array<CatalogueItem>;

package/dist/src/components/c3/index.d.ts

@@ -0,0 +1,7 @@
+import View from './C3.vue';
+import * as controls from './Controls';
+declare const _default: {
+    View: import("vue").VueConstructor<View<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => View>>;
+    controls: typeof controls;
+};
+export default _default;

package/dist/src/components/chart/index.d.ts

@@ -0,0 +1 @@
+export { default as CChart } from './CChart.vue';

package/dist/src/components/corredor/index.d.ts

@@ -0,0 +1 @@
+export { default as CCorredorManualButtons } from './CCorredorManualButtons.vue';

package/dist/src/components/filePreview/index.d.ts

@@ -0,0 +1,3 @@
+export { default as CPreviewLightbox } from './CPreviewLightbox.vue';
+export { default as CPreviewInline } from './CPreviewInline.vue';
+export { canPreview } from './common/index.js';

package/dist/src/components/hint/index.d.ts

@@ -0,0 +1 @@
+export { default as CHint } from './CHint.vue';

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

@@ -0,0 +1,24 @@
+export { CExtendSession, } from './auth';
+export { CCorredorManualButtons, } from './corredor';
+export { CPreviewInline, CPreviewLightbox, canPreview, } from './filePreview';
+export { CInputConfirm, CInputProcessing, CInputDateTime, CInputPresort, CInputSearch, CRichTextInput, CInputCheckbox, CInputColorPicker, CAceEditor, CInputExpression, CButtonSubmit, CInputSelect, CInputRole, CInputUser, CInputUserGroup, } from './input';
+export { CLightbox, } from './lightbox';
+export { CPermissionsButton, CPermissionsModal, } from './permissions';
+export * from './prompts';
+export { CLoaderLogo, } from './loader';
+export { CTopbar, CSidebar, CSidebarNavItems, } from './navigation';
+export { CToaster, CToasterLink, } from './toaster';
+export { CReminderSidebar, } from './reminders';
+export { CItemPicker, CItemPickerItem, } from './itemPicker';
+export { CReportChart, CReportMetric, CReportTable, CReportText, } from './reporter';
+export { CSensitivityLevelPicker, } from './privacy';
+export { CResourceList, } from './resourceList';
+export { CChart, } from './chart';
+export { CProgress, } from './progress';
+export { CToolbar, } from './toolbar';
+export { CHint, } from './hint';
+export { CMap, } from './map';
+export { CFormTableWrapper, } from './wrapper';
+export { CWebcam, } from './webcam';
+export { CNotificationButton, CNotificationSidebar, } from './notifications';
+export { default as C3 } from './c3';

package/dist/src/components/input/CInputDateTime/lib/index.d.ts

@@ -0,0 +1,4 @@
+export declare function getDate(value: string | undefined): string | undefined;
+export declare function getTime(value: string | undefined): string | undefined;
+export declare function setDate(date: string | undefined, value: string | undefined, noDate?: boolean, noTime?: boolean): string | undefined;
+export declare function setTime(time: string | undefined, value: string | undefined, noDate?: boolean, noTime?: boolean): string | undefined;

package/dist/src/components/input/button/index.d.ts

@@ -0,0 +1 @@
+export { default as CButtonSubmit } from './CButtonSubmit.vue';

package/dist/src/components/input/index.d.ts

@@ -0,0 +1,15 @@
+export { default as CInputConfirm } from './CInputConfirm.vue';
+export { default as CInputProcessing } from './CInputProcessing.vue';
+export { default as CInputDateTime } from './CInputDateTime/index.vue';
+export { default as CInputPresort } from './CInputPresort.vue';
+export { default as CInputSearch } from './CInputSearch.vue';
+export { default as CRichTextInput } from './CRichTextInput/index.vue';
+export { default as CInputCheckbox } from './CInputCheckbox.vue';
+export { default as CInputColorPicker } from './CInputColorPicker.vue';
+export { default as CAceEditor } from './CAceEditor.vue';
+export { default as CInputExpression } from './CInputExpression.vue';
+export { CButtonSubmit, } from './button';
+export { default as CInputSelect } from './CInputSelect.vue';
+export { default as CInputRole } from './CInputRole.vue';
+export { default as CInputUser } from './CInputUser.vue';
+export { default as CInputUserGroup } from './CInputUserGroup.vue';

package/dist/src/components/itemPicker/index.d.ts

@@ -0,0 +1,2 @@
+export { default as CItemPicker } from './CItemPicker.vue';
+export { default as CItemPickerItem } from './CItemPickerItem.vue';

package/dist/src/components/lightbox/index.d.ts

@@ -0,0 +1 @@
+export { default as CLightbox } from './CLightbox.vue';

package/dist/src/components/loader/index.d.ts

@@ -0,0 +1 @@
+export { default as CLoaderLogo } from './CLoaderLogo.vue';

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

@@ -0,0 +1 @@
+export { default as CMap } from './CMap.vue';

package/dist/src/components/navigation/index.d.ts

@@ -0,0 +1,3 @@
+export { default as CTopbar } from './CTopbar.vue';
+export { default as CSidebar } from './CSidebar.vue';
+export { default as CSidebarNavItems } from './CSidebarNavItems.vue';

package/dist/src/components/notifications/index.d.ts

@@ -0,0 +1,2 @@
+export { default as CNotificationButton } from './CNotificationButton.vue';
+export { default as CNotificationSidebar } from './CNotificationSidebar.vue';

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

@@ -0,0 +1,6 @@
+import NotificationSimple from './NotificationSimple.vue';
+declare const _default: {
+    NotificationSimple: import("vue").VueConstructor<NotificationSimple<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => NotificationSimple>>;
+    NotificationRecord: import("vue").VueConstructor<NotificationSimple<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => NotificationSimple>>;
+};
+export default _default;

package/dist/src/components/permissions/def.d.ts

@@ -0,0 +1,14 @@
+export declare const modalOpenEventName = "c-permissions-modal-open";
+interface ResourceParts {
+    component: string;
+    resourceType?: string;
+    references: Array<string>;
+    i18nPrefix: string;
+}
+/**
+ * Splitting strings:
+ *  - corteza::compose:moduleField/42/21/12
+ *  - corteza::compose/42/21/12
+ */
+export declare function split(input: string): ResourceParts;
+export {};

package/dist/src/components/permissions/index.d.ts

@@ -0,0 +1,2 @@
+export { default as CPermissionsButton } from './CPermissionsButton.vue';
+export { default as CPermissionsModal } from './CPermissionsModal.vue';

package/dist/src/components/privacy/index.d.ts

@@ -0,0 +1 @@
+export { default as CSensitivityLevelPicker } from './CSensitivityLevelPicker.vue';

package/dist/src/components/progress/index.d.ts

@@ -0,0 +1 @@
+export { default as CProgress } from './CProgress.vue';

package/dist/src/components/prompts/definitions.d.ts

@@ -0,0 +1,2 @@
+import { automation } from '@cortezaproject/corteza-js';
+export declare const prompts: readonly automation.Function[];

package/dist/src/components/prompts/index.d.ts

@@ -0,0 +1,4 @@
+export { default as CPrompts } from './CPrompts.vue';
+export { default as CPromptModal } from './CPromptModal.vue';
+export { default as CPromptToast } from './CPromptToast.vue';
+export { prompts as promptDefinitions } from './definitions';

package/dist/src/components/prompts/kinds/index.d.ts

@@ -0,0 +1,22 @@
+import { Component } from 'vue';
+import { automation } from '@cortezaproject/corteza-js';
+interface Handler {
+    (this: Component, input: automation.Vars): void | Promise<void>;
+}
+interface PromptDefinition {
+    component?: Component;
+    /**
+     *
+     */
+    handler?: Handler;
+    /**
+     * Passive prompt, will not be listed
+     *
+     * Also, when displaying toasts, we'll display all
+     * passive toasts first and then, at the and one single
+     * non-passive toast
+     */
+    passive?: boolean;
+}
+declare const definitions: Record<string, PromptDefinition>;
+export default definitions;

package/dist/src/components/prompts/utils.d.ts

@@ -0,0 +1,3 @@
+import { automation } from '@cortezaproject/corteza-js';
+export declare function pVal<T = unknown>(vars: automation.Vars, k: string, def?: T): T | undefined;
+export declare function pType(vars: automation.Vars, k: string, def?: string): string | undefined;

package/dist/src/components/reminders/index.d.ts

@@ -0,0 +1 @@
+export { default as CReminderSidebar } from './CReminderSidebar.vue';

package/dist/src/components/reporter/index.d.ts

@@ -0,0 +1,4 @@
+export { default as CReportChart } from './Viewers/CReportChart.vue';
+export { default as CReportMetric } from './Viewers/CReportMetric.vue';
+export { default as CReportTable } from './Viewers/CReportTable.vue';
+export { default as CReportText } from './Viewers/CReportText.vue';

package/dist/src/components/resourceList/index.d.ts

@@ -0,0 +1 @@
+export { default as CResourceList } from './CResourceList.vue';

package/dist/src/components/toaster/index.d.ts

@@ -0,0 +1,2 @@
+export { default as CToaster } from './CToaster.vue';
+export { default as CToasterLink } from './CToasterLink.vue';

package/dist/src/components/toolbar/index.d.ts

@@ -0,0 +1 @@
+export { default as CToolbar } from './CToolbar.vue';

package/dist/src/components/webcam/index.d.ts

@@ -0,0 +1 @@
+export { default as CWebcam } from './CWebcam.vue';

package/dist/src/components/wrapper/index.d.ts

@@ -0,0 +1 @@
+export { default as CFormTableWrapper } from './CFormTableWrapper.vue';

package/dist/src/corredor/compose-ctx.d.ts

@@ -0,0 +1,32 @@
+import { compose, apiClients, corredor } from '@cortezaproject/corteza-js';
+import ComposeUIHelper from './compose-ui';
+interface Vue {
+    $SystemAPI: apiClients.System;
+    $ComposeAPI: apiClients.Compose;
+    $store: {
+        getters: {
+            [_: string]: Array<compose.Page>;
+        };
+    };
+    $emit: unknown;
+    $router: {
+        push: unknown;
+    };
+}
+/**
+ * Extends corredor exec context with compose UI helper
+ */
+export default class ComposeCtx extends corredor.Ctx {
+    protected emitter: unknown;
+    protected routePusher: unknown;
+    protected pages: Array<compose.Page>;
+    protected composeUI: ComposeUIHelper;
+    protected vue: Vue;
+    constructor(args: corredor.BaseArgs, vue: Vue);
+    /**
+     * Clones context and uses new arguments
+     */
+    withArgs(args: corredor.BaseArgs): ComposeCtx;
+    get ComposeUI(): ComposeUIHelper;
+}
+export {};

package/dist/src/corredor/compose-ui.d.ts

@@ -0,0 +1,105 @@
+import { compose } from '@cortezaproject/corteza-js';
+interface ComposeUIContext {
+    $namespace?: compose.Namespace;
+    $module?: compose.Module;
+    $record?: compose.Record;
+    pages: Array<compose.Page>;
+    emitter: (...a: any) => any;
+    routePusher: (...a: any) => any;
+}
+/**
+ * ComposeUIHelper provides helpers for accessing Compose's UI
+ *
+ */
+export default class ComposeUIHelper {
+    readonly $namespace?: compose.Namespace;
+    readonly $module?: compose.Module;
+    readonly $record?: compose.Record;
+    readonly pages?: Array<compose.Page>;
+    readonly emitter: (...a: any) => any;
+    readonly routePusher: (...a: any) => any;
+    /**
+     *
+     * @param {Namespace} ctx.$namespace - Current namespace
+     * @param {Module} ctx.$module - Current module
+     * @param {Record} ctx.$record - Current record
+     * @param {Page[]} ctx.pages - Array of Page objects
+     * @param {Function} ctx.emitter - Event emitter (vm.$emit)
+     * @param {Function} ctx.routePusher - Route pusher (vm.$route.push)
+     */
+    constructor(ctx: ComposeUIContext);
+    /**
+     * Open record viewer page
+     *
+     * It searches for page that matches record's module and redirects
+     * user to the view mode on that page
+     *
+     * @example
+     * // Edit current record
+     * ComposeUI.gotoRecordViewer($record)
+     *
+     * // Edit current record ($record can be omitted)
+     * ComposeUI.gotoRecordViewer()
+     *
+     * @param {Record} record
+     */
+    gotoRecordViewer(record?: compose.Record | undefined): void;
+    /**
+     * Open record editor page
+     *
+     * It searches for page that matches record's module and redirects
+     * user to the edit mode on that page.
+     *
+     * @example
+     * // Edit current record
+     * ComposeUI.gotoRecordEditor($record)
+     *
+     * // Edit current record ($record can be omitted)
+     * ComposeUI.gotoRecordEditor()
+     *
+     * @param {Record} record
+     */
+    gotoRecordEditor(record?: compose.Record | undefined): void;
+    /**
+     * Open record page
+     *
+     * @private
+     * @param {string} name
+     * @param {Record} record
+     * @param {string} record.recordID
+     * @param {string} record.moduleID
+     */
+    gotoRecordPage(name: string, record?: compose.Record | undefined): void;
+    /**
+     * Returns record page
+     *
+     */
+    private getRecordPage;
+    /**
+     * Go to a specific route
+     *
+     * @private
+     * @param {string} name
+     * @param {Object} params for $router.push
+     */
+    goto(name: string, params: object): void;
+    /**
+     * Show a success alert
+     *
+     * @example
+     * ComposeUI.success('Change was successful')
+     *
+     * @param message
+     */
+    success(message: string): void;
+    /**
+     * Show a warning alert
+     *
+     * @example
+     * ComposeUI.warning('Could not save your changes')
+     *
+     * @param message
+     */
+    warning(message: string): void;
+}
+export {};

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

@@ -0,0 +1,3 @@
+export { default as WebappCtx } from './webapp-ctx';
+export { default as ComposeCtx } from './compose-ctx';
+export { default as ComposeUIHelper } from './compose-ui';

package/dist/src/corredor/webapp-ctx.d.ts

@@ -0,0 +1,11 @@
+import { corredor } from '@cortezaproject/corteza-js';
+/**
+ * Bare-minimum webapp helper
+ */
+export default class WebappCtx extends corredor.Ctx {
+    constructor(args: corredor.BaseArgs);
+    /**
+     * Clones context and uses new arguments
+     */
+    withArgs(args: corredor.BaseArgs): WebappCtx;
+}

package/dist/src/filters/date.d.ts

@@ -0,0 +1,2 @@
+export declare function locFullDateTime(d: unknown): string;
+export declare function locDate(d: unknown): string;

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

@@ -0,0 +1,2 @@
+export * from './date';
+export * from './url';

package/dist/src/filters/url.d.ts

@@ -0,0 +1 @@
+export declare function checkValidURL(url: string): string;

package/dist/src/i18n.d.ts

@@ -0,0 +1,40 @@
+import { VueConstructor } from 'vue';
+import VueI18Next from '@panter/vue-i18next';
+interface Options {
+    app: string;
+    resources: object;
+    lng: string;
+    fallbackLng: string | false;
+    /**
+     * Namespace(s) to preload
+     */
+    ns: string | Array<string>;
+    /**
+     * Where too look for keys that are not found in the default namespace,
+     */
+    fallbackNS: string | false;
+    /**
+     * What namespace to use when not explicitly defined
+     * When empty, default is set to the value of (the first item in) ns
+     */
+    defaultNS: string;
+    baseURL: string;
+    pseudo: boolean;
+}
+/**
+ * Initializes i18n options, registers plugin on a given Vue instance and returns the options
+ *
+ * To be used as:
+ * import { i18n } from '@cortezaproject/corteza-vue'
+ * new Vue({
+ *   i18n: i18n(Vue, {
+ *     app: 'corteza-webapp-....'
+ *     namespaces: [ .... ]
+ *    }),
+*   })
+ *
+ * The most convenient way to use it:
+ * i18n(Vue, 'app name', 'namespace...', 'additional namespace...')
+ */
+declare const _default: (Vue: VueConstructor, app: string | Partial<Options>, ...namespaces: Array<string>) => VueI18Next;
+export default _default;

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+import * as plugins from './plugins';
+import * as mixins from './mixins';
+import * as components from './components';
+import * as corredor from './corredor';
+import * as filters from './filters';
+import * as store from './store';
+import * as url from './libs/url';
+import * as filter from './libs/filter';
+import * as handle from './libs/handle';
+import * as websocket from './libs/websocket';
+import i18n from './i18n';
+export { plugins, mixins, components, corredor, filters, store, url, filter, handle, websocket, i18n, };

package/dist/src/libs/filter.d.ts

@@ -0,0 +1,3 @@
+export declare function AssertStrict(obj: any, query: string, field?: string, ...fields: Array<string>): boolean;
+export declare function AssertFuzzy(obj: any, query: string, field?: string, ...fields: Array<string>): boolean;
+export declare function Assert(obj: any, query: string, field?: string, ...fields: Array<string>): boolean;

package/dist/src/libs/handle.d.ts

@@ -0,0 +1,4 @@
+export declare const isValid: (h: string) => boolean;
+export declare function handleState(h: string): false | null | undefined;
+export declare const classNamePattern: RegExp;
+export declare function classState(str: string): false | null | undefined;

package/dist/src/libs/url.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Little URL helper
+ *
+ * We need it to handle relative URLs, especially ones w/o schema
+ */
+export declare function Make({ url, query, hash, ref, config }: {
+    url?: string | undefined;
+    query?: {} | undefined;
+    hash?: string | undefined;
+    ref?: string | undefined;
+    config?: {} | undefined;
+}): string;

package/dist/src/libs/websocket.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Default websocket configuration
+ */
+import { Vue } from 'vue/types/vue';
+export declare const config: {
+    format: string;
+    reconnection: boolean;
+    reconnectionAttempts: number;
+    reconnectionDelay: number;
+    connectManually: boolean;
+};
+/**
+ * Extract websocket endpoint from window props (set via config.js)
+ */
+export declare function endpoint(): string;
+/**
+ * Binds auth and websocket events so that we can pass current access token
+ *  - when ws connection opens
+ *  - when auth token in fetched/renewed
+ *
+ *  @todo get rid of ts-ignore lines
+ */
+export declare function init(vue: Vue): void;

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

@@ -0,0 +1,2 @@
+export { default as corredor } from './corredor';
+export { default as files } from './files';