@growi/core 1.0.0-next.0

package/dist/utils/page-utils.js

@@ -0,0 +1,13 @@
+import { isTopPage as n } from "./page-path-utils/is-top-page.js";
+const u = 2, s = 3, o = "deleted", i = (t) => {
+  const { path: r, parent: e } = t;
+  return !!(n(r) || e != null);
+}, a = (t) => {
+  const { grant: r, status: e } = t;
+  return r === u || r === s || e === o || i(t), !0;
+};
+export {
+  i as isOnTree,
+  a as isPageNormalized
+};
+//# sourceMappingURL=page-utils.js.map

package/dist/utils/page-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-utils.js","sources":["../../src/utils/page-utils.ts"],"sourcesContent":["import { IPage } from '..';\n\nimport { isTopPage } from './page-path-utils/is-top-page';\n\n// const GRANT_PUBLIC = 1;\nconst GRANT_RESTRICTED = 2;\nconst GRANT_SPECIFIED = 3; // DEPRECATED\n// const GRANT_OWNER = 4;\n// const GRANT_USER_GROUP = 5;\n// const PAGE_GRANT_ERROR = 1;\n// const STATUS_PUBLISHED = 'published';\nconst STATUS_DELETED = 'deleted';\n\n/**\n * Returns true if the page is on tree including the top page.\n * @param page Page\n * @returns boolean\n */\nexport const isOnTree = (page: IPage): boolean => {\n  const { path, parent } = page;\n\n  if (isTopPage(path)) {\n    return true;\n  }\n\n  if (parent != null) {\n    return true;\n  }\n\n  return false;\n};\n\n/**\n * Returns true if the page meet the condition below.\n *   - The page is on tree (has parent or the top page)\n *   - The page's grant is GRANT_RESTRICTED or GRANT_SPECIFIED\n *   - The page's status is STATUS_DELETED\n * This does not check grantedUser or grantedGroup.\n * @param page PageDocument\n * @returns boolean\n */\nexport const isPageNormalized = (page: IPage): boolean => {\n  const { grant, status } = page;\n\n  if (grant === GRANT_RESTRICTED || grant === GRANT_SPECIFIED) {\n    return true;\n  }\n\n  if (status === STATUS_DELETED) {\n    return true;\n  }\n\n  if (isOnTree(page)) {\n    return true;\n  }\n\n  return true;\n};\n"],"names":["GRANT_RESTRICTED","GRANT_SPECIFIED","STATUS_DELETED","isOnTree","page","path","parent","isTopPage","isPageNormalized","grant","status"],"mappings":";AAKA,MAAMA,IAAmB,GACnBC,IAAkB,GAKlBC,IAAiB,WAOVC,IAAW,CAACC,MAAyB;AAC1C,QAAA,EAAE,MAAAC,GAAM,QAAAC,EAAW,IAAAF;AAMzB,SAJI,GAAAG,EAAUF,CAAI,KAIdC,KAAU;AAKhB,GAWaE,IAAmB,CAACJ,MAAyB;AAClD,QAAA,EAAE,OAAAK,GAAO,QAAAC,EAAW,IAAAN;AAUtB,SARAK,MAAUT,KAAoBS,MAAUR,KAIxCS,MAAWR,KAIXC,EAASC,CAAI,GACR;AAIX;"}

package/dist/utils/path-utils.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function e(n){return n.match(/^((\/+)?(.+?))(\/+)?$/)}function i(n){return n===""?!1:e(n)[2]!=null}function t(n){return n===""?!1:e(n)[4]!=null}function u(n){return n==="/"||i(n)?n:`/${n}`}function a(n){return n==="/"||t(n)?n:`${n}/`}function l(n){return n==="/"?n:i(n)?n.substring(1):n}function s(n){return n==="/"?n:e(n)[1]}function c(n){if(n===""||n==="/")return"/";const r=e(n);return r==null?"/":`/${r[3]}`}function o(n){return`# ${n}`}function f(n,r){return n==="/"?n:u(r)}exports.addHeadingSlash=u;exports.addTrailingSlash=a;exports.attachTitleHeader=o;exports.hasHeadingSlash=i;exports.hasTrailingSlash=t;exports.normalizePath=c;exports.removeHeadingSlash=l;exports.removeTrailingSlash=s;exports.returnPathForURL=f;
+//# sourceMappingURL=path-utils.cjs.map

package/dist/utils/path-utils.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-utils.cjs","sources":["../../src/utils/path-utils.js"],"sourcesContent":["/**\n * @private\n *\n *\n * @param {string} path\n * @returns {RegExpMatchArray}\n * @memberof pathUtils\n */\nfunction matchSlashes(path) {\n  // https://regex101.com/r/Z21fEd/5\n  return path.match(/^((\\/+)?(.+?))(\\/+)?$/);\n}\n\n/**\n *\n * @param {string} path\n * @returns {boolean}\n * @memberof pathUtils\n */\nexport function hasHeadingSlash(path) {\n  if (path === '') {\n    return false;\n  }\n  const match = matchSlashes(path);\n  return (match[2] != null);\n}\n\n/**\n *\n * @param {string} path\n * @returns {boolean}\n * @memberof pathUtils\n */\nexport function hasTrailingSlash(path) {\n  if (path === '') {\n    return false;\n  }\n  const match = matchSlashes(path);\n  return (match[4] != null);\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function addHeadingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  if (!hasHeadingSlash(path)) {\n    return `/${path}`;\n  }\n  return path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function addTrailingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  if (!hasTrailingSlash(path)) {\n    return `${path}/`;\n  }\n  return path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function removeHeadingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  return hasHeadingSlash(path)\n    ? path.substring(1)\n    : path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function removeTrailingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  const match = matchSlashes(path);\n  return match[1];\n}\n\n/**\n * A short-hand method to add heading slash and remove trailing slash.\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function normalizePath(path) {\n  if (path === '' || path === '/') {\n    return '/';\n  }\n\n  const match = matchSlashes(path);\n  if (match == null) {\n    return '/';\n  }\n  return `/${match[3]}`;\n}\n\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function attachTitleHeader(path) {\n  return `# ${path}`;\n}\n\n/**\n * If the pagePath is top page path, eliminate the pageId from the url path.\n *\n * @param {string} path\n * @param {string} id\n * @returns {string}\n * @memberof pathUtils\n */\nexport function returnPathForURL(path, id) {\n  if (path === '/') {\n    return path;\n  }\n\n  return addHeadingSlash(id);\n}\n"],"names":["matchSlashes","path","hasHeadingSlash","hasTrailingSlash","addHeadingSlash","addTrailingSlash","removeHeadingSlash","removeTrailingSlash","normalizePath","match","attachTitleHeader","returnPathForURL","id"],"mappings":"gFAQA,SAASA,EAAaC,EAAM,CAE1B,OAAOA,EAAK,MAAM,uBAAuB,CAC3C,CAQO,SAASC,EAAgBD,EAAM,CACpC,OAAIA,IAAS,GACJ,GAEKD,EAAaC,CAAI,EACjB,CAAC,GAAK,IACtB,CAQO,SAASE,EAAiBF,EAAM,CACrC,OAAIA,IAAS,GACJ,GAEKD,EAAaC,CAAI,EACjB,CAAC,GAAK,IACtB,CAQO,SAASG,EAAgBH,EAAM,CACpC,OAAIA,IAAS,KAIRC,EAAgBD,CAAI,EAHhBA,EAIA,IAAIA,CAAI,EAGnB,CAQO,SAASI,EAAiBJ,EAAM,CACrC,OAAIA,IAAS,KAIRE,EAAiBF,CAAI,EAHjBA,EAIA,GAAGA,CAAI,GAGlB,CAQO,SAASK,EAAmBL,EAAM,CACvC,OAAIA,IAAS,IACJA,EAGFC,EAAgBD,CAAI,EACvBA,EAAK,UAAU,CAAC,EAChBA,CACN,CAQO,SAASM,EAAoBN,EAAM,CACxC,OAAIA,IAAS,IACJA,EAGKD,EAAaC,CAAI,EAClB,CAAC,CAChB,CASO,SAASO,EAAcP,EAAM,CAClC,GAAIA,IAAS,IAAMA,IAAS,IAC1B,MAAO,IAGT,MAAMQ,EAAQT,EAAaC,CAAI,EAC/B,OAAIQ,GAAS,KACJ,IAEF,IAAIA,EAAM,CAAC,CAAC,EACrB,CASO,SAASC,EAAkBT,EAAM,CACtC,MAAO,KAAKA,CAAI,EAClB,CAUO,SAASU,EAAiBV,EAAMW,EAAI,CACzC,OAAIX,IAAS,IACJA,EAGFG,EAAgBQ,CAAE,CAC3B"}

package/dist/utils/path-utils.d.ts

@@ -0,0 +1,66 @@
+/**
+ *
+ * @param {string} path
+ * @returns {boolean}
+ * @memberof pathUtils
+ */
+export function hasHeadingSlash(path: string): boolean;
+/**
+ *
+ * @param {string} path
+ * @returns {boolean}
+ * @memberof pathUtils
+ */
+export function hasTrailingSlash(path: string): boolean;
+/**
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function addHeadingSlash(path: string): string;
+/**
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function addTrailingSlash(path: string): string;
+/**
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function removeHeadingSlash(path: string): string;
+/**
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function removeTrailingSlash(path: string): string;
+/**
+ * A short-hand method to add heading slash and remove trailing slash.
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function normalizePath(path: string): string;
+/**
+ *
+ * @param {string} path
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function attachTitleHeader(path: string): string;
+/**
+ * If the pagePath is top page path, eliminate the pageId from the url path.
+ *
+ * @param {string} path
+ * @param {string} id
+ * @returns {string}
+ * @memberof pathUtils
+ */
+export function returnPathForURL(path: string, id: string): string;

package/dist/utils/path-utils.js

@@ -0,0 +1,45 @@
+function e(n) {
+  return n.match(/^((\/+)?(.+?))(\/+)?$/);
+}
+function u(n) {
+  return n === "" ? !1 : e(n)[2] != null;
+}
+function i(n) {
+  return n === "" ? !1 : e(n)[4] != null;
+}
+function t(n) {
+  return n === "/" || u(n) ? n : `/${n}`;
+}
+function c(n) {
+  return n === "/" || i(n) ? n : `${n}/`;
+}
+function f(n) {
+  return n === "/" ? n : u(n) ? n.substring(1) : n;
+}
+function l(n) {
+  return n === "/" ? n : e(n)[1];
+}
+function o(n) {
+  if (n === "" || n === "/")
+    return "/";
+  const r = e(n);
+  return r == null ? "/" : `/${r[3]}`;
+}
+function s(n) {
+  return `# ${n}`;
+}
+function a(n, r) {
+  return n === "/" ? n : t(r);
+}
+export {
+  t as addHeadingSlash,
+  c as addTrailingSlash,
+  s as attachTitleHeader,
+  u as hasHeadingSlash,
+  i as hasTrailingSlash,
+  o as normalizePath,
+  f as removeHeadingSlash,
+  l as removeTrailingSlash,
+  a as returnPathForURL
+};
+//# sourceMappingURL=path-utils.js.map

package/dist/utils/path-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-utils.js","sources":["../../src/utils/path-utils.js"],"sourcesContent":["/**\n * @private\n *\n *\n * @param {string} path\n * @returns {RegExpMatchArray}\n * @memberof pathUtils\n */\nfunction matchSlashes(path) {\n  // https://regex101.com/r/Z21fEd/5\n  return path.match(/^((\\/+)?(.+?))(\\/+)?$/);\n}\n\n/**\n *\n * @param {string} path\n * @returns {boolean}\n * @memberof pathUtils\n */\nexport function hasHeadingSlash(path) {\n  if (path === '') {\n    return false;\n  }\n  const match = matchSlashes(path);\n  return (match[2] != null);\n}\n\n/**\n *\n * @param {string} path\n * @returns {boolean}\n * @memberof pathUtils\n */\nexport function hasTrailingSlash(path) {\n  if (path === '') {\n    return false;\n  }\n  const match = matchSlashes(path);\n  return (match[4] != null);\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function addHeadingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  if (!hasHeadingSlash(path)) {\n    return `/${path}`;\n  }\n  return path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function addTrailingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  if (!hasTrailingSlash(path)) {\n    return `${path}/`;\n  }\n  return path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function removeHeadingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  return hasHeadingSlash(path)\n    ? path.substring(1)\n    : path;\n}\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function removeTrailingSlash(path) {\n  if (path === '/') {\n    return path;\n  }\n\n  const match = matchSlashes(path);\n  return match[1];\n}\n\n/**\n * A short-hand method to add heading slash and remove trailing slash.\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function normalizePath(path) {\n  if (path === '' || path === '/') {\n    return '/';\n  }\n\n  const match = matchSlashes(path);\n  if (match == null) {\n    return '/';\n  }\n  return `/${match[3]}`;\n}\n\n\n/**\n *\n * @param {string} path\n * @returns {string}\n * @memberof pathUtils\n */\nexport function attachTitleHeader(path) {\n  return `# ${path}`;\n}\n\n/**\n * If the pagePath is top page path, eliminate the pageId from the url path.\n *\n * @param {string} path\n * @param {string} id\n * @returns {string}\n * @memberof pathUtils\n */\nexport function returnPathForURL(path, id) {\n  if (path === '/') {\n    return path;\n  }\n\n  return addHeadingSlash(id);\n}\n"],"names":["matchSlashes","path","hasHeadingSlash","hasTrailingSlash","addHeadingSlash","addTrailingSlash","removeHeadingSlash","removeTrailingSlash","normalizePath","match","attachTitleHeader","returnPathForURL","id"],"mappings":"AAQA,SAASA,EAAaC,GAAM;AAE1B,SAAOA,EAAK,MAAM,uBAAuB;AAC3C;AAQO,SAASC,EAAgBD,GAAM;AACpC,SAAIA,MAAS,KACJ,KAEKD,EAAaC,CAAI,EACjB,CAAC,KAAK;AACtB;AAQO,SAASE,EAAiBF,GAAM;AACrC,SAAIA,MAAS,KACJ,KAEKD,EAAaC,CAAI,EACjB,CAAC,KAAK;AACtB;AAQO,SAASG,EAAgBH,GAAM;AACpC,SAAIA,MAAS,OAIRC,EAAgBD,CAAI,IAHhBA,IAIA,IAAIA,CAAI;AAGnB;AAQO,SAASI,EAAiBJ,GAAM;AACrC,SAAIA,MAAS,OAIRE,EAAiBF,CAAI,IAHjBA,IAIA,GAAGA,CAAI;AAGlB;AAQO,SAASK,EAAmBL,GAAM;AACvC,SAAIA,MAAS,MACJA,IAGFC,EAAgBD,CAAI,IACvBA,EAAK,UAAU,CAAC,IAChBA;AACN;AAQO,SAASM,EAAoBN,GAAM;AACxC,SAAIA,MAAS,MACJA,IAGKD,EAAaC,CAAI,EAClB,CAAC;AAChB;AASO,SAASO,EAAcP,GAAM;AAClC,MAAIA,MAAS,MAAMA,MAAS;AAC1B,WAAO;AAGT,QAAMQ,IAAQT,EAAaC,CAAI;AAC/B,SAAIQ,KAAS,OACJ,MAEF,IAAIA,EAAM,CAAC,CAAC;AACrB;AASO,SAASC,EAAkBT,GAAM;AACtC,SAAO,KAAKA,CAAI;AAClB;AAUO,SAASU,EAAiBV,GAAMW,GAAI;AACzC,SAAIX,MAAS,MACJA,IAGFG,EAAgBQ,CAAE;AAC3B;"}

package/dist/utils/path-utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/template-checker.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});function t(e){return!!e.match(/^.*\/_{1,2}template$/)}exports.checkTemplatePath=t;
+//# sourceMappingURL=template-checker.cjs.map

package/dist/utils/template-checker.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-checker.cjs","sources":["../../src/utils/template-checker.ts"],"sourcesContent":["/**\n * templateChecker\n */\n\nexport function checkTemplatePath(path: string): boolean {\n  if (path.match(/^.*\\/_{1,2}template$/)) {\n    return true;\n  }\n\n  return false;\n}\n"],"names":["checkTemplatePath","path"],"mappings":"gFAIO,SAASA,EAAkBC,EAAuB,CACnD,MAAA,EAAAA,EAAK,MAAM,sBAAsB,CAKvC"}

package/dist/utils/template-checker.d.ts

@@ -0,0 +1,4 @@
+/**
+ * templateChecker
+ */
+export declare function checkTemplatePath(path: string): boolean;

package/dist/utils/template-checker.js

@@ -0,0 +1,7 @@
+function t(e) {
+  return !!e.match(/^.*\/_{1,2}template$/);
+}
+export {
+  t as checkTemplatePath
+};
+//# sourceMappingURL=template-checker.js.map

package/dist/utils/template-checker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-checker.js","sources":["../../src/utils/template-checker.ts"],"sourcesContent":["/**\n * templateChecker\n */\n\nexport function checkTemplatePath(path: string): boolean {\n  if (path.match(/^.*\\/_{1,2}template$/)) {\n    return true;\n  }\n\n  return false;\n}\n"],"names":["checkTemplatePath","path"],"mappings":"AAIO,SAASA,EAAkBC,GAAuB;AACnD,SAAA,EAAAA,EAAK,MAAM,sBAAsB;AAKvC;"}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@growi/core",
+  "version": "1.0.0-next.0",
+  "description": "GROWI Core Libraries",
+  "license": "MIT",
+  "keywords": [
+    "growi"
+  ],
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./dist/consts": {
+      "import": "./dist/consts/index.js",
+      "require": "./dist/consts/index.cjs"
+    },
+    "./dist/interfaces": {
+      "import": "./dist/interfaces/index.js",
+      "require": "./dist/interfaces/index.cjs"
+    },
+    "./dist/models": {
+      "import": "./dist/models/index.js",
+      "require": "./dist/models/index.cjs"
+    },
+    "./dist/remark-plugins": {
+      "import": "./dist/remark-plugins/index.js",
+      "require": "./dist/remark-plugins/index.cjs"
+    },
+    "./dist/swr": {
+      "import": "./dist/swr/index.js",
+      "require": "./dist/swr/index.cjs"
+    },
+    "./dist/utils": {
+      "import": "./dist/utils/index.js",
+      "require": "./dist/utils/index.cjs"
+    },
+    "./dist/utils/page-path-utils": {
+      "import": "./dist/utils/page-path-utils/index.js",
+      "require": "./dist/utils/page-path-utils/index.cjs"
+    },
+    "./dist/utils/*": {
+      "import": "./dist/utils/*.js",
+      "require": "./dist/utils/*.cjs"
+    }
+  },
+  "scripts": {
+    "build": "vite build",
+    "clean": "shx rm -rf dist",
+    "dev": "vite build --mode dev",
+    "watch": "yarn dev -w --emptyOutDir=false",
+    "lint:js": "yarn eslint **/*.{js,ts}",
+    "lint:typecheck": "tsc",
+    "lint": "npm-run-all -p lint:*",
+    "test": "vitest run --coverage"
+  },
+  "// comments for dependencies": {
+    "escape-string-regexp": "5.0.0 or above exports only ESM"
+  },
+  "dependencies": {
+    "bson-objectid": "^2.0.4",
+    "escape-string-regexp": "^4.0.0"
+  },
+  "devDependencies": {
+    "eslint-plugin-regex": "^1.8.0",
+    "swr": "^2.2.2"
+  }
+}