@xwiki/cristal-uiextension-api 1.3.0 → 1.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-uiextension-api",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -41,7 +41,7 @@
     "typescript": "5.9.3",
     "vite": "7.3.2",
     "vue": "3.5.30",
-    "@xwiki/cristal-dev-config": "1.3.0"
+    "@xwiki/cristal-dev-config": "1.4.0"
   },
   "scripts": {
     "api-extractor:local": "api-extractor run --local",

package/dist/index.d.cts

@@ -1,69 +0,0 @@
-import { Component } from 'vue';
-import { ComposerTranslation } from 'vue-i18n';
-/**
- * Define the information held by a UI Extension (UIX).
- *
- * @since 0.11
- * @beta
- */
-interface UIExtension {
-    /**
-     * The unique id of an UI Extension
-     */
-    id: string;
-    /**
-     * The id of the extension point where this UIX should be injected.
-     */
-    uixpName: string;
-    /**
-     * The order of the UIX. The lowest values are expected to be presented
-     * first.
-     */
-    order: number;
-    /**
-     * A free set of parameters.
-     */
-    parameters: {
-        [key: string]: unknown;
-    };
-    /**
-     * Compute if the UIX should be displayed.
-     */
-    enabled(): Promise<boolean>;
-    /**
-     * The UI component of the UIX.
-     */
-    component(): Promise<Component>;
-}
-/**
- * @since 0.11
- * @beta
- */
-interface UIExtensionsManager {
-    /**
-     *
-     * @param name - the name of the UIXP
-     * @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded
-     */
-    list(name: string): Promise<UIExtension[]>;
-}
-/**
- * Abstract class helping with localization of UI extensions.
- *
- * @since 0.23
- * @beta
- */
-declare abstract class AbstractUIExtension implements UIExtension {
-    protected t: ComposerTranslation;
-    constructor(messages: Record<string, Record<string, string>>);
-    abstract id: string;
-    abstract uixpName: string;
-    abstract order: number;
-    abstract parameters: {
-        [key: string]: unknown;
-    };
-    abstract enabled(): Promise<boolean>;
-    abstract component(): Promise<Component>;
-}
-export { AbstractUIExtension };
-export type { UIExtension, UIExtensionsManager };

package/dist/index.d.ts

@@ -1,69 +0,0 @@
-import { Component } from 'vue';
-import { ComposerTranslation } from 'vue-i18n';
-/**
- * Define the information held by a UI Extension (UIX).
- *
- * @since 0.11
- * @beta
- */
-interface UIExtension {
-    /**
-     * The unique id of an UI Extension
-     */
-    id: string;
-    /**
-     * The id of the extension point where this UIX should be injected.
-     */
-    uixpName: string;
-    /**
-     * The order of the UIX. The lowest values are expected to be presented
-     * first.
-     */
-    order: number;
-    /**
-     * A free set of parameters.
-     */
-    parameters: {
-        [key: string]: unknown;
-    };
-    /**
-     * Compute if the UIX should be displayed.
-     */
-    enabled(): Promise<boolean>;
-    /**
-     * The UI component of the UIX.
-     */
-    component(): Promise<Component>;
-}
-/**
- * @since 0.11
- * @beta
- */
-interface UIExtensionsManager {
-    /**
-     *
-     * @param name - the name of the UIXP
-     * @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded
-     */
-    list(name: string): Promise<UIExtension[]>;
-}
-/**
- * Abstract class helping with localization of UI extensions.
- *
- * @since 0.23
- * @beta
- */
-declare abstract class AbstractUIExtension implements UIExtension {
-    protected t: ComposerTranslation;
-    constructor(messages: Record<string, Record<string, string>>);
-    abstract id: string;
-    abstract uixpName: string;
-    abstract order: number;
-    abstract parameters: {
-        [key: string]: unknown;
-    };
-    abstract enabled(): Promise<boolean>;
-    abstract component(): Promise<Component>;
-}
-export { AbstractUIExtension };
-export type { UIExtension, UIExtensionsManager };

package/dist/index.es.js

@@ -1,24 +0,0 @@
-import { injectable as l, unmanaged as m } from "inversify";
-import { useI18n as i } from "vue-i18n";
-var p = Object.getOwnPropertyDescriptor, v = (e, t, o, r) => {
-  for (var s = r > 1 ? void 0 : r ? p(t, o) : t, a = e.length - 1, n; a >= 0; a--)
-    (n = e[a]) && (s = n(s) || s);
-  return s;
-}, _ = (e, t) => (o, r) => t(o, r, e);
-let c = class {
-  t;
-  constructor(e) {
-    const { t, mergeLocaleMessage: o } = i();
-    for (const r in e)
-      o(r, e[r]);
-    this.t = t;
-  }
-};
-c = v([
-  l(),
-  _(0, m())
-], c);
-export {
-  c as AbstractUIExtension
-};
-//# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.es.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { injectable, unmanaged } from \"inversify\";\nimport { useI18n } from \"vue-i18n\";\nimport type { Component } from \"vue\";\nimport type { ComposerTranslation } from \"vue-i18n\";\n\n/**\n * Define the information held by a UI Extension (UIX).\n *\n * @since 0.11\n * @beta\n */\ninterface UIExtension {\n  /**\n   * The unique id of an UI Extension\n   */\n  id: string;\n\n  /**\n   * The id of the extension point where this UIX should be injected.\n   */\n  uixpName: string;\n\n  /**\n   * The order of the UIX. The lowest values are expected to be presented\n   * first.\n   */\n  order: number;\n\n  /**\n   * A free set of parameters.\n   */\n  parameters: { [key: string]: unknown };\n\n  /**\n   * Compute if the UIX should be displayed.\n   */\n  enabled(): Promise<boolean>;\n\n  /**\n   * The UI component of the UIX.\n   */\n  component(): Promise<Component>;\n}\n\n/**\n * @since 0.11\n * @beta\n */\ninterface UIExtensionsManager {\n  /**\n   *\n   * @param name - the name of the UIXP\n   * @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded\n   */\n  list(name: string): Promise<UIExtension[]>;\n}\n\n/**\n * Abstract class helping with localization of UI extensions.\n *\n * @since 0.23\n * @beta\n */\n@injectable()\nabstract class AbstractUIExtension implements UIExtension {\n  protected t: ComposerTranslation;\n\n  constructor(@unmanaged() messages: Record<string, Record<string, string>>) {\n    const { t, mergeLocaleMessage } = useI18n();\n    for (const messagesKey in messages) {\n      mergeLocaleMessage(messagesKey, messages[messagesKey]);\n    }\n    this.t = t;\n  }\n\n  abstract id: string;\n  abstract uixpName: string;\n  abstract order: number;\n  abstract parameters: { [key: string]: unknown };\n\n  abstract enabled(): Promise<boolean>;\n  abstract component(): Promise<Component>;\n}\n\nexport { AbstractUIExtension };\nexport type { UIExtension, UIExtensionsManager };\n"],"names":["AbstractUIExtension","messages","mergeLocaleMessage","useI18n","messagesKey","__decorateClass","injectable","__decorateParam","unmanaged"],"mappings":";;;;;;;AAoFA,IAAeA,IAAf,MAA0D;AAAA,EAC9C;AAAA,EAEV,YAAyBC,GAAkD;AACzE,UAAM,EAAE,GAAG,oBAAAC,EAAA,IAAuBC,EAAA;AAClC,eAAWC,KAAeH;AACxB,MAAAC,EAAmBE,GAAaH,EAASG,CAAW,CAAC;AAEvD,SAAK,IAAI;AAAA,EACX;AASF;AAlBeJ,IAAfK,EAAA;AAAA,EADCC,EAAA;AAAA,EAIcC,EAAA,GAAAC,EAAA,CAAU;AAAA,GAHVR,CAAA;"}

package/dist/index.umd.js

@@ -1,2 +0,0 @@
-(function(e,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("inversify"),require("vue-i18n")):typeof define=="function"&&define.amd?define(["exports","inversify","vue-i18n"],i):(e=typeof globalThis<"u"?globalThis:e||self,i(e["cristal_uiextension-api"]={},e.inversify,e.vueI18n))})(this,(function(e,i,a){"use strict";var f=Object.getOwnPropertyDescriptor,d=(r,t,o,s)=>{for(var n=s>1?void 0:s?f(t,o):t,u=r.length-1,c;u>=0;u--)(c=r[u])&&(n=c(n)||n);return n},v=(r,t)=>(o,s)=>t(o,s,r);e.AbstractUIExtension=class{t;constructor(t){const{t:o,mergeLocaleMessage:s}=a.useI18n();for(const n in t)s(n,t[n]);this.t=o}},e.AbstractUIExtension=d([i.injectable(),v(0,i.unmanaged())],e.AbstractUIExtension),Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})}));
-//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.umd.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * See the LICENSE file distributed with this work for additional\n * information regarding copyright ownership.\n *\n * This is free software; you can redistribute it and/or modify it\n * under the terms of the GNU Lesser General Public License as\n * published by the Free Software Foundation; either version 2.1 of\n * the License, or (at your option) any later version.\n *\n * This software is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\n * Lesser General Public License for more details.\n *\n * You should have received a copy of the GNU Lesser General Public\n * License along with this software; if not, write to the Free\n * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA\n * 02110-1301 USA, or see the FSF site: http://www.fsf.org.\n */\n\nimport { injectable, unmanaged } from \"inversify\";\nimport { useI18n } from \"vue-i18n\";\nimport type { Component } from \"vue\";\nimport type { ComposerTranslation } from \"vue-i18n\";\n\n/**\n * Define the information held by a UI Extension (UIX).\n *\n * @since 0.11\n * @beta\n */\ninterface UIExtension {\n  /**\n   * The unique id of an UI Extension\n   */\n  id: string;\n\n  /**\n   * The id of the extension point where this UIX should be injected.\n   */\n  uixpName: string;\n\n  /**\n   * The order of the UIX. The lowest values are expected to be presented\n   * first.\n   */\n  order: number;\n\n  /**\n   * A free set of parameters.\n   */\n  parameters: { [key: string]: unknown };\n\n  /**\n   * Compute if the UIX should be displayed.\n   */\n  enabled(): Promise<boolean>;\n\n  /**\n   * The UI component of the UIX.\n   */\n  component(): Promise<Component>;\n}\n\n/**\n * @since 0.11\n * @beta\n */\ninterface UIExtensionsManager {\n  /**\n   *\n   * @param name - the name of the UIXP\n   * @returns a list of UIExtension components, sorted by ascending order. disabled UIExtensions are excluded\n   */\n  list(name: string): Promise<UIExtension[]>;\n}\n\n/**\n * Abstract class helping with localization of UI extensions.\n *\n * @since 0.23\n * @beta\n */\n@injectable()\nabstract class AbstractUIExtension implements UIExtension {\n  protected t: ComposerTranslation;\n\n  constructor(@unmanaged() messages: Record<string, Record<string, string>>) {\n    const { t, mergeLocaleMessage } = useI18n();\n    for (const messagesKey in messages) {\n      mergeLocaleMessage(messagesKey, messages[messagesKey]);\n    }\n    this.t = t;\n  }\n\n  abstract id: string;\n  abstract uixpName: string;\n  abstract order: number;\n  abstract parameters: { [key: string]: unknown };\n\n  abstract enabled(): Promise<boolean>;\n  abstract component(): Promise<Component>;\n}\n\nexport { AbstractUIExtension };\nexport type { UIExtension, UIExtensionsManager };\n"],"names":["AbstractUIExtension","messages","t","mergeLocaleMessage","useI18n","messagesKey","__decorateClass","injectable","__decorateParam","unmanaged"],"mappings":"kfAoFeA,EAAAA,oBAAf,KAA0D,CAC9C,EAEV,YAAyBC,EAAkD,CACzE,KAAM,CAAE,EAAAC,EAAG,mBAAAC,CAAA,EAAuBC,UAAA,EAClC,UAAWC,KAAeJ,EACxBE,EAAmBE,EAAaJ,EAASI,CAAW,CAAC,EAEvD,KAAK,EAAIH,CACX,CASF,EAlBeF,EAAAA,oBAAfM,EAAA,CADCC,aAAA,EAIcC,EAAA,EAAAC,YAAA,CAAU,CAAA,EAHVT,qBAAA"}