@xwiki/cristal-page-api 0.21.1 → 0.23.0

package/CHANGELOG.md

@@ -1,10 +1,16 @@
 # @xwiki/cristal-page-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

@@ -20,6 +20,7 @@
 /**
  * Provide the operations to read a page content
  * @since 0.20
+ * @beta
  */
 interface PageReader {
     /**
@@ -34,6 +35,7 @@ interface PageReader {
 }
 /**
  * @since 0.20
+ * @beta
  */
 interface PageWriter {
     writePage(pageContent: {

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH;;;GAGG;AACH,UAAU,UAAU;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3D;AAED;;GAEG;AACH,UAAU,UAAU;IAClB,SAAS,CAAC,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,MAAM,CAAC;CAC5D;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;GAIG;AACH,UAAU,UAAU;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAC3D;AAED;;;GAGG;AACH,UAAU,UAAU;IAClB,SAAS,CAAC,WAAW,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,GAAG,MAAM,CAAC;CAC5D;AAED,YAAY,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC"}

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

@@ -0,0 +1,24 @@
+## API Report File for "@xwiki/cristal-page-api"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+// @beta
+export interface PageReader {
+    readPage(pageContent: string): {
+        [key: string]: unknown;
+    };
+}
+
+// @beta (undocumented)
+export interface PageWriter {
+    // (undocumented)
+    writePage(pageContent: {
+        [key: string]: unknown;
+    }): string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-page-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/",
@@ -18,19 +18,20 @@
       "types": "./dist/index.d.ts"
     }
   },
-  "types": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "peerDependencies": {
     "inversify": "7.x",
     "reflect-metadata": "0.x"
   },
   "devDependencies": {
-    "inversify": "7.7.0",
+    "inversify": "7.10.2",
     "reflect-metadata": "0.2.2",
-    "typescript": "5.9.2",
-    "@xwiki/cristal-dev-config": "0.21.1"
+    "typescript": "5.9.3",
+    "@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

@@ -17,9 +17,11 @@
  * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
  */
+
 /**
  * Provide the operations to read a page content
  * @since 0.20
+ * @beta
  */
 interface PageReader {
   /**
@@ -33,6 +35,7 @@ interface PageReader {
 
 /**
  * @since 0.20
+ * @beta
  */
 interface PageWriter {
   writePage(pageContent: { [key: string]: unknown }): string;