@xwiki/cristal-rename-api 0.21.1 → 0.22.0

package/CHANGELOG.md

@@ -1,12 +1,15 @@
 # @xwiki/cristal-rename-api
 
-## 0.21.1
+## 0.22.0
+
+### Minor Changes
+
+- Cristal 0.22 Release
 
 ### Patch Changes
 
-- Cristal 0.21.1 Release
 - Updated dependencies
-  - @xwiki/cristal-api@0.21.1
+  - @xwiki/cristal-api@0.22.0
 
 ## 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.cts

@@ -3,6 +3,7 @@ import { PageData } from '@xwiki/cristal-api';
  * A PageRenameManager can handle page rename operations.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManager {
     /**
@@ -23,6 +24,7 @@ interface PageRenameManager {
  * matching the current wiki configuration.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManagerProvider {
     /**
@@ -43,6 +45,7 @@ interface PageRenameManagerProvider {
 /**
  * The component id of PageRenameManager.
  * @since 0.14
+ * @beta
  */
 declare const name = "PageRenameManager";
 export { type PageRenameManager, type PageRenameManagerProvider, name };

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { PageData } from '@xwiki/cristal-api';
  * A PageRenameManager can handle page rename operations.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManager {
     /**
@@ -23,6 +24,7 @@ interface PageRenameManager {
  * matching the current wiki configuration.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManagerProvider {
     /**
@@ -43,6 +45,7 @@ interface PageRenameManagerProvider {
 /**
  * The component id of PageRenameManager.
  * @since 0.14
+ * @beta
  */
 declare const name = "PageRenameManager";
 export { type PageRenameManager, type PageRenameManagerProvider, name };

package/dist/index.es.js.map

@@ -1 +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 type { PageData } from \"@xwiki/cristal-api\";\n\n/**\n * A PageRenameManager can handle page rename operations.\n *\n * @since 0.14\n **/\ninterface PageRenameManager {\n  /**\n   * Change the reference of a given page.\n   *\n   * @param pageData - the page for which to get the revisions\n   * @param newReference - the new reference for the page\n   * @param preserveChildren - whether to also affect children\n   * @returns true if this was successful, false with the reason otherwise\n   */\n  updateReference(\n    page: PageData,\n    newReference: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }>;\n\n  /* TODO: Fix CRISTAL-84 and add operations to update backlinks and set-up\n     automatic redirects. */\n}\n\n/**\n * A PageRenameManagerProvider returns the instance of {@link PageRenameManager}\n * matching the current wiki configuration.\n *\n * @since 0.14\n **/\ninterface PageRenameManagerProvider {\n  /**\n   * Check whether an instance of PageRenameManager matching the current wiki\n   * configuration exists.\n   *\n   * @returns whether or not an instance exists\n   */\n  has(): boolean;\n\n  /**\n   * Return the instance of PageRenameManager matching the current wiki\n   * configuration.\n   *\n   * @returns the instance of PageRenameManager\n   */\n  get(): PageRenameManager;\n}\n\n/**\n * The component id of PageRenameManager.\n * @since 0.14\n */\nconst name = \"PageRenameManager\";\n\nexport { type PageRenameManager, type PageRenameManagerProvider, name };\n"],"names":["name"],"mappings":"AA0EA,MAAMA,IAAO;"}
+{"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 type { PageData } from \"@xwiki/cristal-api\";\n\n/**\n * A PageRenameManager can handle page rename operations.\n *\n * @since 0.14\n * @beta\n **/\ninterface PageRenameManager {\n  /**\n   * Change the reference of a given page.\n   *\n   * @param pageData - the page for which to get the revisions\n   * @param newReference - the new reference for the page\n   * @param preserveChildren - whether to also affect children\n   * @returns true if this was successful, false with the reason otherwise\n   */\n  updateReference(\n    page: PageData,\n    newReference: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }>;\n\n  /* TODO: Fix CRISTAL-84 and add operations to update backlinks and set-up\n     automatic redirects. */\n}\n\n/**\n * A PageRenameManagerProvider returns the instance of {@link PageRenameManager}\n * matching the current wiki configuration.\n *\n * @since 0.14\n * @beta\n **/\ninterface PageRenameManagerProvider {\n  /**\n   * Check whether an instance of PageRenameManager matching the current wiki\n   * configuration exists.\n   *\n   * @returns whether or not an instance exists\n   */\n  has(): boolean;\n\n  /**\n   * Return the instance of PageRenameManager matching the current wiki\n   * configuration.\n   *\n   * @returns the instance of PageRenameManager\n   */\n  get(): PageRenameManager;\n}\n\n/**\n * The component id of PageRenameManager.\n * @since 0.14\n * @beta\n */\nconst name = \"PageRenameManager\";\n\nexport { type PageRenameManager, type PageRenameManagerProvider, name };\n"],"names":["name"],"mappings":"AA6EA,MAAMA,IAAO;"}

package/dist/index.umd.js

@@ -1,2 +1,2 @@
-(function(e,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(e=typeof globalThis<"u"?globalThis:e||self,n(e["cristal_rename-api"]={}))})(this,function(e){"use strict";const n="PageRenameManager";e.name=n,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(e,n){typeof exports=="object"&&typeof module<"u"?n(exports):typeof define=="function"&&define.amd?define(["exports"],n):(e=typeof globalThis<"u"?globalThis:e||self,n(e["cristal_rename-api"]={}))})(this,(function(e){"use strict";const n="PageRenameManager";e.name=n,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})}));
 //# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -1 +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 type { PageData } from \"@xwiki/cristal-api\";\n\n/**\n * A PageRenameManager can handle page rename operations.\n *\n * @since 0.14\n **/\ninterface PageRenameManager {\n  /**\n   * Change the reference of a given page.\n   *\n   * @param pageData - the page for which to get the revisions\n   * @param newReference - the new reference for the page\n   * @param preserveChildren - whether to also affect children\n   * @returns true if this was successful, false with the reason otherwise\n   */\n  updateReference(\n    page: PageData,\n    newReference: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }>;\n\n  /* TODO: Fix CRISTAL-84 and add operations to update backlinks and set-up\n     automatic redirects. */\n}\n\n/**\n * A PageRenameManagerProvider returns the instance of {@link PageRenameManager}\n * matching the current wiki configuration.\n *\n * @since 0.14\n **/\ninterface PageRenameManagerProvider {\n  /**\n   * Check whether an instance of PageRenameManager matching the current wiki\n   * configuration exists.\n   *\n   * @returns whether or not an instance exists\n   */\n  has(): boolean;\n\n  /**\n   * Return the instance of PageRenameManager matching the current wiki\n   * configuration.\n   *\n   * @returns the instance of PageRenameManager\n   */\n  get(): PageRenameManager;\n}\n\n/**\n * The component id of PageRenameManager.\n * @since 0.14\n */\nconst name = \"PageRenameManager\";\n\nexport { type PageRenameManager, type PageRenameManagerProvider, name };\n"],"names":["name"],"mappings":"6OA0EA,MAAMA,EAAO"}
+{"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 type { PageData } from \"@xwiki/cristal-api\";\n\n/**\n * A PageRenameManager can handle page rename operations.\n *\n * @since 0.14\n * @beta\n **/\ninterface PageRenameManager {\n  /**\n   * Change the reference of a given page.\n   *\n   * @param pageData - the page for which to get the revisions\n   * @param newReference - the new reference for the page\n   * @param preserveChildren - whether to also affect children\n   * @returns true if this was successful, false with the reason otherwise\n   */\n  updateReference(\n    page: PageData,\n    newReference: string,\n    preserveChildren: boolean,\n  ): Promise<{ success: boolean; error?: string }>;\n\n  /* TODO: Fix CRISTAL-84 and add operations to update backlinks and set-up\n     automatic redirects. */\n}\n\n/**\n * A PageRenameManagerProvider returns the instance of {@link PageRenameManager}\n * matching the current wiki configuration.\n *\n * @since 0.14\n * @beta\n **/\ninterface PageRenameManagerProvider {\n  /**\n   * Check whether an instance of PageRenameManager matching the current wiki\n   * configuration exists.\n   *\n   * @returns whether or not an instance exists\n   */\n  has(): boolean;\n\n  /**\n   * Return the instance of PageRenameManager matching the current wiki\n   * configuration.\n   *\n   * @returns the instance of PageRenameManager\n   */\n  get(): PageRenameManager;\n}\n\n/**\n * The component id of PageRenameManager.\n * @since 0.14\n * @beta\n */\nconst name = \"PageRenameManager\";\n\nexport { type PageRenameManager, type PageRenameManagerProvider, name };\n"],"names":["name"],"mappings":"8OA6EA,MAAMA,EAAO"}

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

@@ -0,0 +1,29 @@
+## API Report File for "@xwiki/cristal-rename-api"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { PageData } from '@xwiki/cristal-api';
+
+// @beta
+const name_2 = "PageRenameManager";
+export { name_2 as name }
+
+// @beta
+export interface PageRenameManager {
+    updateReference(page: PageData, newReference: string, preserveChildren: boolean): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+}
+
+// @beta
+export interface PageRenameManagerProvider {
+    get(): PageRenameManager;
+    has(): boolean;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-rename-api",
-  "version": "0.21.1",
+  "version": "0.22.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -26,18 +26,20 @@
     }
   },
   "main": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
   "dependencies": {
-    "@xwiki/cristal-api": "0.21.1"
+    "@xwiki/cristal-api": "0.22.0"
   },
   "devDependencies": {
     "typescript": "5.9.2",
-    "vite": "7.0.6",
-    "@xwiki/cristal-dev-config": "0.21.1"
+    "vite": "7.1.5",
+    "@xwiki/cristal-dev-config": "0.22.0"
   },
   "scripts": {
-    "build": "tsc --project tsconfig.json && vite build",
+    "api-extractor:local": "api-extractor run --local",
+    "build": "vite build",
     "clean": "rimraf dist",
-    "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0"
-  },
-  "types": "./dist/index.d.ts"
+    "lint": "eslint \"./src/**/*.{ts,tsx,vue}\" --max-warnings=0",
+    "typecheck": "tsc"
+  }
 }

package/src/index.ts

@@ -24,6 +24,7 @@ import type { PageData } from "@xwiki/cristal-api";
  * A PageRenameManager can handle page rename operations.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManager {
   /**
@@ -49,6 +50,7 @@ interface PageRenameManager {
  * matching the current wiki configuration.
  *
  * @since 0.14
+ * @beta
  **/
 interface PageRenameManagerProvider {
   /**
@@ -71,6 +73,7 @@ interface PageRenameManagerProvider {
 /**
  * The component id of PageRenameManager.
  * @since 0.14
+ * @beta
  */
 const name = "PageRenameManager";