@xwiki/cristal-uiextension-api 0.23.0 → 0.23.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xwiki/cristal-uiextension-api
 
+## 0.23.1
+
+### Patch Changes
+
+- Cristal 0.23.1 Release
+
 ## 0.23.0
 
 ### Minor Changes

package/dist/index.d.cts

@@ -0,0 +1,69 @@
+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,24 +1,5 @@
-/**
- * See the LICENSE file distributed with this work for additional
- * information regarding copyright ownership.
- *
- * This is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License as
- * published by the Free Software Foundation; either version 2.1 of
- * the License, or (at your option) any later version.
- *
- * This software is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this software; if not, write to the Free
- * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
- * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
- */
-import type { Component } from "vue";
-import type { ComposerTranslation } from "vue-i18n";
+import { Component } from 'vue';
+import { ComposerTranslation } from 'vue-i18n';
 /**
  * Define the information held by a UI Extension (UIX).
  *
@@ -86,4 +67,3 @@ declare abstract class AbstractUIExtension implements UIExtension {
 }
 export { AbstractUIExtension };
 export type { UIExtension, UIExtensionsManager };
-//# sourceMappingURL=index.d.ts.map

package/dist/index.es.js

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,2 @@
+(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

@@ -0,0 +1 @@
+{"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"}

package/etc/cristal-uiextension-api.api.md

@@ -4,8 +4,8 @@
 
 ```ts
 
-import type { Component } from 'vue';
-import type { ComposerTranslation } from 'vue-i18n';
+import { Component } from 'vue';
+import { ComposerTranslation } from 'vue-i18n';
 
 // @beta
 export abstract class AbstractUIExtension implements UIExtension {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-uiextension-api",
-  "version": "0.23.0",
+  "version": "0.23.1",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -15,11 +15,17 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./src/index.ts"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.es.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.umd.js"
+      }
     }
   },
-  "main": "./src/index.ts",
+  "main": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
     "vue-i18n": "11.1.12"
@@ -30,14 +36,19 @@
     "vue": "3.x"
   },
   "devDependencies": {
+    "inversify": "7.10.2",
+    "reflect-metadata": "0.2.2",
     "typescript": "5.9.3",
+    "vite": "7.1.9",
     "vue": "3.5.22",
-    "@xwiki/cristal-dev-config": "0.23.0"
+    "@xwiki/cristal-dev-config": "0.23.1"
   },
   "scripts": {
     "api-extractor:local": "api-extractor run --local",
-    "build": "rimraf dist && tsc",
+    "build": "vite build",
     "clean": "rimraf dist",
-    "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
+    "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0",
+    "test": "vitest --run",
+    "typecheck": "tsc"
   }
 }

package/tsconfig.json

@@ -2,10 +2,7 @@
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",
-    "resolveJsonModule": true,
-    "emitDeclarationOnly": true,
-    "noEmit": false,
-    "declarationMap": true
+    "resolveJsonModule": true
   },
   "extends": "../../../tsconfig.json",
   "include": [

package/vite.config.ts

@@ -0,0 +1,23 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+import { generateConfig } from "../../../vite.config";
+
+export default generateConfig(import.meta.url);

package/vitest.config.ts

@@ -0,0 +1,25 @@
+/**
+ * See the LICENSE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * This is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as
+ * published by the Free Software Foundation; either version 2.1 of
+ * the License, or (at your option) any later version.
+ *
+ * This software is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this software; if not, write to the Free
+ * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+ * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
+ */
+
+import localConfig from "./vite.config";
+import { vitestVue as defaultConfig } from "@xwiki/cristal-dev-config";
+import { mergeConfig } from "vitest/config";
+
+export default mergeConfig(defaultConfig, localConfig);

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AACrC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAEpD;;;;;GAKG;AACH,UAAU,WAAW;IACnB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEvC;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;CACjC;AAED;;;GAGG;AACH,UAAU,mBAAmB;IAC3B;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC5C;AAED;;;;;GAKG;AACH,uBACe,mBAAoB,YAAW,WAAW;IACvD,SAAS,CAAC,CAAC,EAAE,mBAAmB,CAAC;gBAER,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAQzE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEhD,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IACpC,QAAQ,CAAC,SAAS,IAAI,OAAO,CAAC,SAAS,CAAC;CACzC;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC;AAC/B,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC"}