@xwiki/cristal-uiextension-api 0.21.1 → 0.23.0

package/CHANGELOG.md

@@ -1,10 +1,16 @@
 # @xwiki/cristal-uiextension-api
 
-## 0.21.1
+## 0.23.0
 
-### Patch Changes
+### Minor Changes
+
+- Cristal 0.23 Release
+
+## 0.22.0
+
+### Minor Changes
 
-- Cristal 0.21.1 Release
+- Cristal 0.22 Release
 
 ## 0.21.0
 

package/api-extractor.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "extends": "../../../api-extractor.json"
+}

package/dist/index.d.ts

@@ -17,11 +17,13 @@
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
-import { Component } from "vue";
+import type { Component } from "vue";
+import type { ComposerTranslation } from "vue-i18n";
 /**
  * Define the information held by a UI Extension (UIX).
  *
  * @since 0.11
+ * @beta
  */
 interface UIExtension {
     /**
@@ -54,6 +56,7 @@ interface UIExtension {
 }
 /**
  * @since 0.11
+ * @beta
  */
 interface UIExtensionsManager {
     /**
@@ -63,5 +66,24 @@ interface UIExtensionsManager {
      */
     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 };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,KAAK,CAAC;AAEhC;;;;GAIG;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;;GAEG;AACH,UAAU,mBAAmB;IAC3B;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;CAC5C;AAED,YAAY,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC"}
+{"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"}

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

@@ -0,0 +1,51 @@
+## API Report File for "@xwiki/cristal-uiextension-api"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Component } from 'vue';
+import type { ComposerTranslation } from 'vue-i18n';
+
+// @beta
+export abstract class AbstractUIExtension implements UIExtension {
+    constructor(messages: Record<string, Record<string, string>>);
+    // (undocumented)
+    abstract component(): Promise<Component>;
+    // (undocumented)
+    abstract enabled(): Promise<boolean>;
+    // (undocumented)
+    abstract id: string;
+    // (undocumented)
+    abstract order: number;
+    // (undocumented)
+    abstract parameters: {
+        [key: string]: unknown;
+    };
+    // (undocumented)
+    protected t: ComposerTranslation;
+    // (undocumented)
+    abstract uixpName: string;
+}
+
+// @beta
+export interface UIExtension {
+    component(): Promise<Component>;
+    enabled(): Promise<boolean>;
+    id: string;
+    order: number;
+    parameters: {
+        [key: string]: unknown;
+    };
+    uixpName: string;
+}
+
+// @beta (undocumented)
+export interface UIExtensionsManager {
+    // (undocumented)
+    list(name: string): Promise<UIExtension[]>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-uiextension-api",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -15,21 +15,28 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts"
+      "types": "./dist/index.d.ts",
+      "import": "./src/index.ts"
     }
   },
-  "types": "./src/index.ts",
+  "main": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "vue-i18n": "11.1.12"
+  },
   "peerDependencies": {
+    "inversify": "7.x",
     "reflect-metadata": "0.x",
     "vue": "3.x"
   },
   "devDependencies": {
-    "typescript": "5.9.2",
-    "vue": "3.5.18",
-    "@xwiki/cristal-dev-config": "0.21.1"
+    "typescript": "5.9.3",
+    "vue": "3.5.22",
+    "@xwiki/cristal-dev-config": "0.23.0"
   },
   "scripts": {
-    "build": "rimraf dist && tsc --project tsconfig.json",
+    "api-extractor:local": "api-extractor run --local",
+    "build": "rimraf dist && tsc",
     "clean": "rimraf dist",
     "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
   }

package/src/index.ts

@@ -18,12 +18,16 @@
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
 
-import { Component } from "vue";
+import { injectable, unmanaged } from "inversify";
+import { useI18n } from "vue-i18n";
+import type { Component } from "vue";
+import type { ComposerTranslation } from "vue-i18n";
 
 /**
  * Define the information held by a UI Extension (UIX).
  *
  * @since 0.11
+ * @beta
  */
 interface UIExtension {
   /**
@@ -60,6 +64,7 @@ interface UIExtension {
 
 /**
  * @since 0.11
+ * @beta
  */
 interface UIExtensionsManager {
   /**
@@ -70,4 +75,32 @@ interface UIExtensionsManager {
   list(name: string): Promise<UIExtension[]>;
 }
 
+/**
+ * Abstract class helping with localization of UI extensions.
+ *
+ * @since 0.23
+ * @beta
+ */
+@injectable()
+abstract class AbstractUIExtension implements UIExtension {
+  protected t: ComposerTranslation;
+
+  constructor(@unmanaged() messages: Record<string, Record<string, string>>) {
+    const { t, mergeLocaleMessage } = useI18n();
+    for (const messagesKey in messages) {
+      mergeLocaleMessage(messagesKey, messages[messagesKey]);
+    }
+    this.t = t;
+  }
+
+  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 };