@xwiki/cristal-settings-api 0.21.0 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xwiki/cristal-settings-api
 
+## 0.22.0
+
+### Minor Changes
+
+- Cristal 0.22 Release
+
 ## 0.21.0
 
 ### Minor Changes

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/settings.d.ts

@@ -22,6 +22,7 @@
  * This should be extended with a properly typed "content" attribute for
  * specific settings.
  * @since 0.18
+ * @beta
  */
 export interface Settings {
     key: string;

package/dist/settings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/dist/settingsManager.d.ts

@@ -21,6 +21,7 @@ import type { Settings } from "./settings";
 /**
  * A SettingsManager handles operations on Cristal's settings.
  * @since 0.18
+ * @beta
  */
 export interface SettingsManager {
     /**

package/dist/settingsManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settingsManager.d.ts","sourceRoot":"","sources":["../src/settingsManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,GAAG,CAAC,CAAC,SAAS,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE1D;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B"}
+{"version":3,"file":"settingsManager.d.ts","sourceRoot":"","sources":["../src/settingsManager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE9B;;;;OAIG;IACH,GAAG,CAAC,CAAC,SAAS,QAAQ,EAAE,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE1D;;;OAGG;IACH,MAAM,IAAI,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B"}

package/dist/settingsParser.d.ts

@@ -24,6 +24,7 @@ import type { Settings } from "./settings";
  * a named component, with the name being the "key" attribute of the Settings'
  * concrete type.
  * @since 0.18
+ * @beta
  */
 interface SettingsParser {
     /**
@@ -37,6 +38,7 @@ interface SettingsParser {
  * A SettingsParserProvider retrieves the best instance of SettingsParser for
  * a given Settings key.
  * @since 0.18
+ * @beta
  */
 interface SettingsParserProvider {
     /**

package/dist/settingsParser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settingsParser.d.ts","sourceRoot":"","sources":["../src/settingsParser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;;GAMG;AACH,UAAU,cAAc;IACtB;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC1D;AAED;;;;GAIG;AACH,UAAU,sBAAsB;IAC9B;;;;OAIG;IACH,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;CACpC;AAED,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,CAAC"}
+{"version":3,"file":"settingsParser.d.ts","sourceRoot":"","sources":["../src/settingsParser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;;;GAOG;AACH,UAAU,cAAc;IACtB;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAC;CAC1D;AAED;;;;;GAKG;AACH,UAAU,sBAAsB;IAC9B;;;;OAIG;IACH,GAAG,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC;CACpC;AAED,YAAY,EAAE,cAAc,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/settingsStorage.d.ts

@@ -22,6 +22,7 @@ import type { SettingsManager } from "./settingsManager";
  * A SettingsStorage can persistently store and retrieve settings, from and to
  * a {@link SettingsManager} instance.
  * @since 0.18
+ * @beta
  */
 export interface SettingsStorage {
     /**

package/dist/settingsStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"settingsStorage.d.ts","sourceRoot":"","sources":["../src/settingsStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;OAGG;IACH,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD"}
+{"version":3,"file":"settingsStorage.d.ts","sourceRoot":"","sources":["../src/settingsStorage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD;;;OAGG;IACH,IAAI,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD"}

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

@@ -0,0 +1,41 @@
+## API Report File for "@xwiki/cristal-settings-api"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @beta
+export interface Settings {
+    // (undocumented)
+    content: unknown;
+    // (undocumented)
+    key: string;
+}
+
+// @beta
+export interface SettingsManager {
+    fromJSON(json: string): void;
+    get<T extends Settings>(type: new () => T): T | undefined;
+    set(settings: Settings): void;
+    toJSON(): string;
+}
+
+// @beta
+export interface SettingsParser {
+    parse(serializedSettings: string, key: string): Settings;
+}
+
+// @beta
+export interface SettingsParserProvider {
+    get(type?: string): SettingsParser;
+}
+
+// @beta
+export interface SettingsStorage {
+    load(settingsManager: SettingsManager): Promise<void>;
+    save(settingsManager: SettingsManager): Promise<void>;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-settings-api",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -18,14 +18,15 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "types": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "devDependencies": {
     "typescript": "5.9.2",
-    "@xwiki/cristal-dev-config": "0.21.0",
-    "@xwiki/cristal-dsapi": "0.21.0"
+    "@xwiki/cristal-dsapi": "0.22.0",
+    "@xwiki/cristal-dev-config": "0.22.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/settings.ts

@@ -23,6 +23,7 @@
  * This should be extended with a properly typed "content" attribute for
  * specific settings.
  * @since 0.18
+ * @beta
  */
 export interface Settings {
   key: string;

package/src/settingsManager.ts

@@ -23,6 +23,7 @@ import type { Settings } from "./settings";
 /**
  * A SettingsManager handles operations on Cristal's settings.
  * @since 0.18
+ * @beta
  */
 export interface SettingsManager {
   /**

package/src/settingsParser.ts

@@ -26,6 +26,7 @@ import type { Settings } from "./settings";
  * a named component, with the name being the "key" attribute of the Settings'
  * concrete type.
  * @since 0.18
+ * @beta
  */
 interface SettingsParser {
   /**
@@ -40,6 +41,7 @@ interface SettingsParser {
  * A SettingsParserProvider retrieves the best instance of SettingsParser for
  * a given Settings key.
  * @since 0.18
+ * @beta
  */
 interface SettingsParserProvider {
   /**

package/src/settingsStorage.ts

@@ -24,6 +24,7 @@ import type { SettingsManager } from "./settingsManager";
  * A SettingsStorage can persistently store and retrieve settings, from and to
  * a {@link SettingsManager} instance.
  * @since 0.18
+ * @beta
  */
 export interface SettingsStorage {
   /**