@xwiki/cristal-xwiki-utils 0.21.0 → 0.22.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xwiki/cristal-xwiki-utils
 
+## 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/index.d.cts

@@ -6,5 +6,6 @@ import { WikiConfig } from '@xwiki/cristal-api';
  * @param documentId - the id of the document
  * @returns the crafted URL
  * @since 0.9
+ * @beta
  */
 export declare function getRestSpacesApiUrl(wikiConfig: WikiConfig, documentId: string): string;

package/dist/index.d.ts

@@ -6,5 +6,6 @@ import { WikiConfig } from '@xwiki/cristal-api';
  * @param documentId - the id of the document
  * @returns the crafted URL
  * @since 0.9
+ * @beta
  */
 export declare function getRestSpacesApiUrl(wikiConfig: WikiConfig, documentId: string): string;

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 { WikiConfig } from \"@xwiki/cristal-api\";\n\n/**\n * Returns URL to XWiki spaces rest API for a given document.\n *\n * @param wikiConfig - the current wiki configuration\n * @param documentId - the id of the document\n * @returns the crafted URL\n * @since 0.9\n */\nexport function getRestSpacesApiUrl(\n  wikiConfig: WikiConfig,\n  documentId: string,\n): string {\n  const splittedDocumentId = documentId.split(\":\");\n  const wiki = splittedDocumentId.length > 1 ? splittedDocumentId[0] : \"xwiki\";\n  const doc =\n    splittedDocumentId.length > 1\n      ? splittedDocumentId[1]\n      : splittedDocumentId[0];\n  return `${wikiConfig.baseURL}/rest/wikis/${wiki}/spaces/${encodeURIComponent(\n    doc,\n  )\n    .replace(/((?:%5C%5C)*)%5C\\./g, \"$1%2E\") // Unescape dots in identifiers\n    .replace(/%5C%5C/g, \"%5C\") // Unescape backslashes in identifiers\n    .replace(/\\.(?=.*\\.)/g, \"/spaces/\") // Transform separators to spaces endpoints\n    .replace(/\\./, \"/pages/\")}`; // Transform last separator to pages endpoint\n}\n"],"names":["getRestSpacesApiUrl","wikiConfig","documentId","splittedDocumentId","wiki","doc"],"mappings":"AA8BO,SAASA,EACdC,GACAC,GACQ;AACR,QAAMC,IAAqBD,EAAW,MAAM,GAAG,GACzCE,IAAOD,EAAmB,SAAS,IAAIA,EAAmB,CAAC,IAAI,SAC/DE,IACJF,EAAmB,SAAS,IACxBA,EAAmB,CAAC,IACpBA,EAAmB,CAAC;AAC1B,SAAO,GAAGF,EAAW,OAAO,eAAeG,CAAI,WAAW;AAAA,IACxDC;AAAA,EAAA,EAEC,QAAQ,uBAAuB,OAAO,EACtC,QAAQ,WAAW,KAAK,EACxB,QAAQ,eAAe,UAAU,EACjC,QAAQ,MAAM,SAAS,CAAC;AAC7B;"}
+{"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 { WikiConfig } from \"@xwiki/cristal-api\";\n\n/**\n * Returns URL to XWiki spaces rest API for a given document.\n *\n * @param wikiConfig - the current wiki configuration\n * @param documentId - the id of the document\n * @returns the crafted URL\n * @since 0.9\n * @beta\n */\nexport function getRestSpacesApiUrl(\n  wikiConfig: WikiConfig,\n  documentId: string,\n): string {\n  const splittedDocumentId = documentId.split(\":\");\n  const wiki = splittedDocumentId.length > 1 ? splittedDocumentId[0] : \"xwiki\";\n  const doc =\n    splittedDocumentId.length > 1\n      ? splittedDocumentId[1]\n      : splittedDocumentId[0];\n  return `${wikiConfig.baseURL}/rest/wikis/${wiki}/spaces/${encodeURIComponent(\n    doc,\n  )\n    .replace(/((?:%5C%5C)*)%5C\\./g, \"$1%2E\") // Unescape dots in identifiers\n    .replace(/%5C%5C/g, \"%5C\") // Unescape backslashes in identifiers\n    .replace(/\\.(?=.*\\.)/g, \"/spaces/\") // Transform separators to spaces endpoints\n    .replace(/\\./, \"/pages/\")}`; // Transform last separator to pages endpoint\n}\n"],"names":["getRestSpacesApiUrl","wikiConfig","documentId","splittedDocumentId","wiki","doc"],"mappings":"AA+BO,SAASA,EACdC,GACAC,GACQ;AACR,QAAMC,IAAqBD,EAAW,MAAM,GAAG,GACzCE,IAAOD,EAAmB,SAAS,IAAIA,EAAmB,CAAC,IAAI,SAC/DE,IACJF,EAAmB,SAAS,IACxBA,EAAmB,CAAC,IACpBA,EAAmB,CAAC;AAC1B,SAAO,GAAGF,EAAW,OAAO,eAAeG,CAAI,WAAW;AAAA,IACxDC;AAAA,EAAA,EAEC,QAAQ,uBAAuB,OAAO,EACtC,QAAQ,WAAW,KAAK,EACxB,QAAQ,eAAe,UAAU,EACjC,QAAQ,MAAM,SAAS,CAAC;AAC7B;"}

package/dist/index.umd.js

@@ -1,2 +1,2 @@
-(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e["cristal_xwiki-utils"]={}))})(this,function(e){"use strict";function t(n,s){const i=s.split(":"),o=i.length>1?i[0]:"xwiki",p=i.length>1?i[1]:i[0];return`${n.baseURL}/rest/wikis/${o}/spaces/${encodeURIComponent(p).replace(/((?:%5C%5C)*)%5C\./g,"$1%2E").replace(/%5C%5C/g,"%5C").replace(/\.(?=.*\.)/g,"/spaces/").replace(/\./,"/pages/")}`}e.getRestSpacesApiUrl=t,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})});
+(function(e,t){typeof exports=="object"&&typeof module<"u"?t(exports):typeof define=="function"&&define.amd?define(["exports"],t):(e=typeof globalThis<"u"?globalThis:e||self,t(e["cristal_xwiki-utils"]={}))})(this,(function(e){"use strict";function t(n,s){const i=s.split(":"),o=i.length>1?i[0]:"xwiki",p=i.length>1?i[1]:i[0];return`${n.baseURL}/rest/wikis/${o}/spaces/${encodeURIComponent(p).replace(/((?:%5C%5C)*)%5C\./g,"$1%2E").replace(/%5C%5C/g,"%5C").replace(/\.(?=.*\.)/g,"/spaces/").replace(/\./,"/pages/")}`}e.getRestSpacesApiUrl=t,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 { WikiConfig } from \"@xwiki/cristal-api\";\n\n/**\n * Returns URL to XWiki spaces rest API for a given document.\n *\n * @param wikiConfig - the current wiki configuration\n * @param documentId - the id of the document\n * @returns the crafted URL\n * @since 0.9\n */\nexport function getRestSpacesApiUrl(\n  wikiConfig: WikiConfig,\n  documentId: string,\n): string {\n  const splittedDocumentId = documentId.split(\":\");\n  const wiki = splittedDocumentId.length > 1 ? splittedDocumentId[0] : \"xwiki\";\n  const doc =\n    splittedDocumentId.length > 1\n      ? splittedDocumentId[1]\n      : splittedDocumentId[0];\n  return `${wikiConfig.baseURL}/rest/wikis/${wiki}/spaces/${encodeURIComponent(\n    doc,\n  )\n    .replace(/((?:%5C%5C)*)%5C\\./g, \"$1%2E\") // Unescape dots in identifiers\n    .replace(/%5C%5C/g, \"%5C\") // Unescape backslashes in identifiers\n    .replace(/\\.(?=.*\\.)/g, \"/spaces/\") // Transform separators to spaces endpoints\n    .replace(/\\./, \"/pages/\")}`; // Transform last separator to pages endpoint\n}\n"],"names":["getRestSpacesApiUrl","wikiConfig","documentId","splittedDocumentId","wiki","doc"],"mappings":"8OA8BO,SAASA,EACdC,EACAC,EACQ,CACR,MAAMC,EAAqBD,EAAW,MAAM,GAAG,EACzCE,EAAOD,EAAmB,OAAS,EAAIA,EAAmB,CAAC,EAAI,QAC/DE,EACJF,EAAmB,OAAS,EACxBA,EAAmB,CAAC,EACpBA,EAAmB,CAAC,EAC1B,MAAO,GAAGF,EAAW,OAAO,eAAeG,CAAI,WAAW,mBACxDC,CAAA,EAEC,QAAQ,sBAAuB,OAAO,EACtC,QAAQ,UAAW,KAAK,EACxB,QAAQ,cAAe,UAAU,EACjC,QAAQ,KAAM,SAAS,CAAC,EAC7B"}
+{"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 { WikiConfig } from \"@xwiki/cristal-api\";\n\n/**\n * Returns URL to XWiki spaces rest API for a given document.\n *\n * @param wikiConfig - the current wiki configuration\n * @param documentId - the id of the document\n * @returns the crafted URL\n * @since 0.9\n * @beta\n */\nexport function getRestSpacesApiUrl(\n  wikiConfig: WikiConfig,\n  documentId: string,\n): string {\n  const splittedDocumentId = documentId.split(\":\");\n  const wiki = splittedDocumentId.length > 1 ? splittedDocumentId[0] : \"xwiki\";\n  const doc =\n    splittedDocumentId.length > 1\n      ? splittedDocumentId[1]\n      : splittedDocumentId[0];\n  return `${wikiConfig.baseURL}/rest/wikis/${wiki}/spaces/${encodeURIComponent(\n    doc,\n  )\n    .replace(/((?:%5C%5C)*)%5C\\./g, \"$1%2E\") // Unescape dots in identifiers\n    .replace(/%5C%5C/g, \"%5C\") // Unescape backslashes in identifiers\n    .replace(/\\.(?=.*\\.)/g, \"/spaces/\") // Transform separators to spaces endpoints\n    .replace(/\\./, \"/pages/\")}`; // Transform last separator to pages endpoint\n}\n"],"names":["getRestSpacesApiUrl","wikiConfig","documentId","splittedDocumentId","wiki","doc"],"mappings":"+OA+BO,SAASA,EACdC,EACAC,EACQ,CACR,MAAMC,EAAqBD,EAAW,MAAM,GAAG,EACzCE,EAAOD,EAAmB,OAAS,EAAIA,EAAmB,CAAC,EAAI,QAC/DE,EACJF,EAAmB,OAAS,EACxBA,EAAmB,CAAC,EACpBA,EAAmB,CAAC,EAC1B,MAAO,GAAGF,EAAW,OAAO,eAAeG,CAAI,WAAW,mBACxDC,CAAA,EAEC,QAAQ,sBAAuB,OAAO,EACtC,QAAQ,UAAW,KAAK,EACxB,QAAQ,cAAe,UAAU,EACjC,QAAQ,KAAM,SAAS,CAAC,EAC7B"}

package/etc/cristal-xwiki-utils.api.md

@@ -0,0 +1,14 @@
+## API Report File for "@xwiki/cristal-xwiki-utils"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { WikiConfig } from '@xwiki/cristal-api';
+
+// @beta
+export function getRestSpacesApiUrl(wikiConfig: WikiConfig, documentId: string): string;
+
+// (No @packageDocumentation comment for this package)
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xwiki/cristal-xwiki-utils",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "license": "LGPL 2.1",
   "author": "XWiki Org Community <contact@xwiki.org>",
   "homepage": "https://cristal.xwiki.org/",
@@ -26,17 +26,19 @@
     }
   },
   "main": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
   "devDependencies": {
     "typescript": "5.9.2",
-    "vite": "7.0.6",
-    "@xwiki/cristal-api": "0.21.0",
-    "@xwiki/cristal-dev-config": "0.21.0"
+    "vite": "7.1.5",
+    "@xwiki/cristal-api": "0.22.0",
+    "@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",
-    "test": "vitest --run"
-  },
-  "types": "./dist/index.d.ts"
+    "test": "vitest --run",
+    "typecheck": "tsc"
+  }
 }

package/src/index.ts

@@ -27,6 +27,7 @@ import type { WikiConfig } from "@xwiki/cristal-api";
  * @param documentId - the id of the document
  * @returns the crafted URL
  * @since 0.9
+ * @beta
  */
 export function getRestSpacesApiUrl(
   wikiConfig: WikiConfig,

package/vitest.config.ts

@@ -19,7 +19,7 @@
  */
 
 import localConfig from "./vite.config";
-import defaultConfig from "@xwiki/cristal-dev-config/vitest-vue.config";
+import { vitestVue as defaultConfig } from "@xwiki/cristal-dev-config";
 import { mergeConfig } from "vitest/config";
 
 export default mergeConfig(defaultConfig, localConfig);