docus 1.0.4 → 2.1.0

package/dist/runtime/database/Query.mjs

@@ -0,0 +1,49 @@
+export class BaseQueryBuilder {
+  constructor() {
+    this.params = {
+      skip: 0,
+      limit: 0,
+      only: [],
+      without: [],
+      sortBy: [],
+      where: {}
+    };
+  }
+  only(keys) {
+    this.params.only = Array.isArray(keys) ? keys : [keys];
+    return this;
+  }
+  without(keys) {
+    this.params.without = Array.isArray(keys) ? keys : [keys];
+    return this;
+  }
+  sortBy(field, direction) {
+    this.params.sortBy.push([field, direction]);
+    return this;
+  }
+  where(query) {
+    this.params.where = query;
+    return this;
+  }
+  surround(slugOrTo, options) {
+    this.params.surround = {
+      slugOrTo,
+      options
+    };
+    return this;
+  }
+  limit(count) {
+    if (typeof count === "string") {
+      count = parseInt(count);
+    }
+    this.params.limit = count;
+    return this;
+  }
+  skip(count) {
+    if (typeof count === "string") {
+      count = parseInt(count);
+    }
+    this.params.skip = count;
+    return this;
+  }
+}

package/dist/runtime/database/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Create the database out of the choosen provider
+ */
+export declare function createDatabase(navigation: any): Promise<any>;

package/dist/runtime/database/index.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDatabase = createDatabase;
+
+var _object = require("../utils/object");
+
+var _context = require("../context");
+
+var _local = _interopRequireDefault(require("./providers/local"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+async function createDatabase(navigation) {
+  const {
+    database: {
+      provider,
+      options
+    }
+  } = (0, _context.useDocusContext)();
+  let db;
+
+  switch (provider) {
+    case "local":
+    default:
+      db = (0, _local.default)(options);
+  }
+
+  await initializeDatabase(db, navigation);
+  return db;
+}
+
+function initializeDatabase(db, navigation) {
+  function index(item) {
+    db?.setItem(item.id, (0, _object.omit)(["children"])(item));
+
+    if (item.children) {
+      item.children.forEach(index);
+    }
+  }
+
+  Object.values(navigation || {}).flatMap(i => i).forEach(index);
+}

package/dist/runtime/database/index.mjs

@@ -0,0 +1,25 @@
+import { omit } from "../utils/object.mjs";
+import { useDocusContext } from "../context.mjs";
+import createLocalDatabase from "./providers/local/index.mjs";
+export async function createDatabase(navigation) {
+  const {
+    database: { provider, options }
+  } = useDocusContext();
+  let db;
+  switch (provider) {
+    case "local":
+    default:
+      db = createLocalDatabase(options);
+  }
+  await initializeDatabase(db, navigation);
+  return db;
+}
+function initializeDatabase(db, navigation) {
+  function index(item) {
+    db?.setItem(item.id, omit(["children"])(item));
+    if (item.children) {
+      item.children.forEach(index);
+    }
+  }
+  Object.values(navigation || {}).flatMap((i) => i).forEach(index);
+}

package/dist/runtime/database/providers/local/Query.d.ts

@@ -0,0 +1,14 @@
+import { BaseQueryBuilder } from '../../Query';
+export default class Query<T> extends BaseQueryBuilder<T> {
+    items: any[];
+    base: string;
+    dbUrl: string;
+    constructor(to: string, { base, db, ...params }?: any);
+    /**
+     * Call server middleware with generated params
+     * @returns {(Object|Array)} Returns processed data
+     */
+    remoteFetch(): any;
+    initDBFromNavigationData(dataUrl: string): Promise<any[]>;
+    fetch(params?: QueryBuilderParams): Promise<T | T[]>;
+}

package/dist/runtime/database/providers/local/Query.js

@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+module.exports = void 0;
+
+var _ohmyfetch = require("ohmyfetch");
+
+var _object = require("../../../utils/object");
+
+var _Query = require("../../Query");
+
+var _operations = require("./operations");
+
+var _utils = require("./utils");
+
+class Query extends _Query.BaseQueryBuilder {
+  constructor(to, {
+    base = "",
+    db = null,
+    ...params
+  } = {}) {
+    super();
+    this.items = [];
+    this.dbUrl = "";
+    this.base = base;
+    Object.assign(this.params, params);
+    this.params.to = this.params.to || to;
+    this.items = db;
+
+    if (typeof db === "string") {
+      this.dbUrl = db;
+    }
+  }
+
+  remoteFetch() {
+    return globalThis.$fetch(this.base, {
+      method: "POST",
+      body: JSON.stringify(this.params),
+      headers: {
+        "Content-Type": "application/json"
+      }
+    });
+  }
+
+  async initDBFromNavigationData(dataUrl) {
+    const {
+      body: navigation
+    } = await (0, _ohmyfetch.$fetch)(dataUrl);
+    const _items = [];
+
+    function index(item) {
+      _items.push({ ...item,
+        children: void 0
+      });
+
+      if (item.children) {
+        item.children.forEach(index);
+      }
+    }
+
+    Object.values(navigation || {}).flatMap(i => i).forEach(index);
+    return _items;
+  }
+
+  async fetch(params = this.params) {
+    if (this.dbUrl) {
+      this.items = await this.initDBFromNavigationData(this.dbUrl);
+    }
+
+    if (!this.items) {
+      return this.remoteFetch();
+    }
+
+    const data = this.items;
+    params = params || this.params;
+    const pipelines = [data2 => params.to ? data2.filter(item => item.to === params.to || item.to.startsWith(params.to)) : data2, data2 => data2.filter(item => (0, _operations.match)(item, params.where)), data2 => params.sortBy.forEach(([key, direction]) => (0, _utils.sortByKey)(data2, key, direction)), data2 => params.skip ? data2.slice(params.skip) : data2, data2 => params.limit ? data2.slice(0, params.limit) : data2, (0, _object.apply)((0, _object.omit)(params.without)), (0, _object.apply)((0, _object.pick)(params.only)), data2 => !params.deep && data2[0]?.to === params.to ? data2[0] : data2];
+    const result = pipelines.reduce((value, fn) => fn(value) || value, data);
+    return result;
+  }
+
+}
+
+module.exports = Query;

package/dist/runtime/database/providers/local/Query.mjs

@@ -0,0 +1,60 @@
+import { $fetch } from "ohmyfetch";
+import { apply, omit, pick } from "../../../utils/object.mjs";
+import { BaseQueryBuilder } from "../../Query.mjs";
+import { match } from "./operations.mjs";
+import { sortByKey } from "./utils.mjs";
+export default class Query extends BaseQueryBuilder {
+  constructor(to, { base = "", db = null, ...params } = {}) {
+    super();
+    this.items = [];
+    this.dbUrl = "";
+    this.base = base;
+    Object.assign(this.params, params);
+    this.params.to = this.params.to || to;
+    this.items = db;
+    if (typeof db === "string") {
+      this.dbUrl = db;
+    }
+  }
+  remoteFetch() {
+    return globalThis.$fetch(this.base, {
+      method: "POST",
+      body: JSON.stringify(this.params),
+      headers: { "Content-Type": "application/json" }
+    });
+  }
+  async initDBFromNavigationData(dataUrl) {
+    const { body: navigation } = await $fetch(dataUrl);
+    const _items = [];
+    function index(item) {
+      _items.push({ ...item, children: void 0 });
+      if (item.children) {
+        item.children.forEach(index);
+      }
+    }
+    Object.values(navigation || {}).flatMap((i) => i).forEach(index);
+    return _items;
+  }
+  async fetch(params = this.params) {
+    if (this.dbUrl) {
+      this.items = await this.initDBFromNavigationData(this.dbUrl);
+    }
+    if (!this.items) {
+      return this.remoteFetch();
+    }
+    const data = this.items;
+    params = params || this.params;
+    const pipelines = [
+      (data2) => params.to ? data2.filter((item) => item.to === params.to || item.to.startsWith(params.to)) : data2,
+      (data2) => data2.filter((item) => match(item, params.where)),
+      (data2) => params.sortBy.forEach(([key, direction]) => sortByKey(data2, key, direction)),
+      (data2) => params.skip ? data2.slice(params.skip) : data2,
+      (data2) => params.limit ? data2.slice(0, params.limit) : data2,
+      apply(omit(params.without)),
+      apply(pick(params.only)),
+      (data2) => !params.deep && data2[0]?.to === params.to ? data2[0] : data2
+    ];
+    const result = pipelines.reduce((value, fn) => fn(value) || value, data);
+    return result;
+  }
+}

package/dist/runtime/database/providers/local/index.d.ts

@@ -0,0 +1,3 @@
+import { DatabaseProvider } from 'types';
+export default function createArrayDatabase(_options?: {}): DatabaseProvider;
+export declare const createDatabase: typeof createArrayDatabase;

package/dist/runtime/database/providers/local/index.js

@@ -0,0 +1,63 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createDatabase = void 0;
+module.exports = createArrayDatabase;
+
+var _Query = _interopRequireDefault(require("./Query"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function createArrayDatabase(_options = {}) {
+  const database = {};
+
+  const query = (path, params) => {
+    const to = typeof path === "string" ? path : "";
+    const opts = (typeof path === "object" ? path : params) || {};
+    return new _Query.default(to, { ...opts,
+      db: Object.values(database)
+    });
+  };
+
+  const getItem = key => database[key];
+
+  const setItem = (key, document) => {
+    database[key] = document;
+  };
+
+  const removeItem = key => {
+    delete database[key];
+  };
+
+  const clear = () => {
+    for (const key in database) {
+      removeItem(key);
+    }
+  };
+
+  const search = (to, params) => query(to, params).fetch();
+
+  const serialize = () => Promise.resolve(JSON.stringify(database));
+
+  const load = data => {
+    clear();
+    Object.assign(database, JSON.parse(data));
+    return Promise.resolve();
+  };
+
+  return {
+    getItem,
+    setItem,
+    removeItem,
+    clear,
+    query,
+    search,
+    serialize,
+    load
+  };
+}
+
+const createDatabase = createArrayDatabase;
+exports.createDatabase = createDatabase;

package/dist/runtime/database/providers/local/index.mjs

@@ -0,0 +1,39 @@
+import ArrayQuery from "./Query.mjs";
+export default function createArrayDatabase(_options = {}) {
+  const database = {};
+  const query = (path, params) => {
+    const to = typeof path === "string" ? path : "";
+    const opts = (typeof path === "object" ? path : params) || {};
+    return new ArrayQuery(to, { ...opts, db: Object.values(database) });
+  };
+  const getItem = (key) => database[key];
+  const setItem = (key, document) => {
+    database[key] = document;
+  };
+  const removeItem = (key) => {
+    delete database[key];
+  };
+  const clear = () => {
+    for (const key in database) {
+      removeItem(key);
+    }
+  };
+  const search = (to, params) => query(to, params).fetch();
+  const serialize = () => Promise.resolve(JSON.stringify(database));
+  const load = (data) => {
+    clear();
+    Object.assign(database, JSON.parse(data));
+    return Promise.resolve();
+  };
+  return {
+    getItem,
+    setItem,
+    removeItem,
+    clear,
+    query,
+    search,
+    serialize,
+    load
+  };
+}
+export const createDatabase = createArrayDatabase;

package/dist/runtime/database/providers/local/operations.d.ts

@@ -0,0 +1,2 @@
+export declare const get: (obj: any, path: string) => any;
+export declare function match(item: any, where: any): boolean;

package/dist/runtime/database/providers/local/operations.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.get = void 0;
+exports.match = match;
+
+const get = (obj, path) => path.split(".").reduce((acc, part) => acc && acc[part], obj);
+
+exports.get = get;
+
+function match(item, where) {
+  return Object.keys(where || {}).every(key => {
+    const condition = where[key];
+
+    if (key.startsWith("$")) {
+      return $operator(item, key, condition);
+    }
+
+    const value = get(item, key);
+
+    if (typeof condition === "object") {
+      return match(value, condition);
+    }
+
+    return value === condition;
+  });
+}
+
+function $operator(item, operator, condition) {
+  switch (operator) {
+    case "$not":
+      return !match(item, condition);
+
+    case "$and":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+
+      return condition.every(cond => match(item, cond));
+
+    case "$or":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+
+      return condition.some(cond => match(item, cond));
+
+    case "$ne":
+      return item !== condition;
+
+    case "$eq":
+      return item === condition;
+
+    case "$in":
+      return (Array.isArray(condition) ? condition : [condition]).includes(item);
+
+    case "$contains":
+      item = Array.isArray(item) ? item : String(item);
+      return Array.isArray(condition) ? condition.every(i => item.includes(i)) : item.includes(condition);
+
+    case "$containsAny":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+
+      item = Array.isArray(item) ? item : String(item);
+      return condition.some(i => item.includes(i));
+
+    case "$exists":
+      return condition ? typeof item !== "undefined" : typeof item === "undefined";
+
+    case "$type":
+      {
+        const type = typeof item;
+        return type === String(condition);
+      }
+
+    default:
+      return false;
+  }
+}

package/dist/runtime/database/providers/local/operations.mjs

@@ -0,0 +1,53 @@
+export const get = (obj, path) => path.split(".").reduce((acc, part) => acc && acc[part], obj);
+export function match(item, where) {
+  return Object.keys(where || {}).every((key) => {
+    const condition = where[key];
+    if (key.startsWith("$")) {
+      return $operator(item, key, condition);
+    }
+    const value = get(item, key);
+    if (typeof condition === "object") {
+      return match(value, condition);
+    }
+    return value === condition;
+  });
+}
+function $operator(item, operator, condition) {
+  switch (operator) {
+    case "$not":
+      return !match(item, condition);
+    case "$and":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+      return condition.every((cond) => match(item, cond));
+    case "$or":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+      return condition.some((cond) => match(item, cond));
+    case "$ne":
+      return item !== condition;
+    case "$eq":
+      return item === condition;
+    case "$in":
+      return (Array.isArray(condition) ? condition : [condition]).includes(item);
+    case "$contains":
+      item = Array.isArray(item) ? item : String(item);
+      return Array.isArray(condition) ? condition.every((i) => item.includes(i)) : item.includes(condition);
+    case "$containsAny":
+      if (!Array.isArray(condition)) {
+        throw new TypeError("$containsAny requires an array as condition");
+      }
+      item = Array.isArray(item) ? item : String(item);
+      return condition.some((i) => item.includes(i));
+    case "$exists":
+      return condition ? typeof item !== "undefined" : typeof item === "undefined";
+    case "$type": {
+      const type = typeof item;
+      return type === String(condition);
+    }
+    default:
+      return false;
+  }
+}

package/dist/runtime/database/providers/local/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Comperator to sort array of objects based on a property
+ */
+export declare const sortComparable: (key: string, direction: string | boolean) => (a: any, b: any) => 0 | 1 | -1;
+/**
+ * Sort an array based on a key
+ */
+export declare const sortByKey: (data: any[], key: string, direction: string | boolean) => any[];

package/dist/runtime/database/providers/local/utils.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.sortComparable = exports.sortByKey = void 0;
+
+var _operations = require("./operations");
+
+const sortComparable = (key, direction) => (a, b) => {
+  const values = [(0, _operations.get)(a, key), (0, _operations.get)(b, key)];
+
+  if (direction === "desc" || direction === true) {
+    values.reverse();
+  }
+
+  if (values[0] === void 0) return 1;
+  if (values[1] === void 0) return -1;
+  if (values[0] > values[1]) return 1;
+  if (values[0] < values[1]) return -1;
+  return 0;
+};
+
+exports.sortComparable = sortComparable;
+
+const sortByKey = (data, key, direction) => data.sort(sortComparable(key, direction));
+
+exports.sortByKey = sortByKey;

package/dist/runtime/database/providers/local/utils.mjs

@@ -0,0 +1,17 @@
+import { get } from "./operations.mjs";
+export const sortComparable = (key, direction) => (a, b) => {
+  const values = [get(a, key), get(b, key)];
+  if (direction === "desc" || direction === true) {
+    values.reverse();
+  }
+  if (values[0] === void 0)
+    return 1;
+  if (values[1] === void 0)
+    return -1;
+  if (values[0] > values[1])
+    return 1;
+  if (values[0] < values[1])
+    return -1;
+  return 0;
+};
+export const sortByKey = (data, key, direction) => data.sort(sortComparable(key, direction));

package/dist/runtime/index.d.ts

@@ -0,0 +1,3 @@
+export * from './utils';
+export * from './app/composables';
+export * from '@docus/mdc/utils';

package/dist/runtime/index.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+
+var _utils = require("./utils");
+
+Object.keys(_utils).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _utils[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _utils[key];
+    }
+  });
+});
+
+var _composables = require("./app/composables");
+
+Object.keys(_composables).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _composables[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _composables[key];
+    }
+  });
+});
+
+var _utils2 = require("@docus/mdc/utils");
+
+Object.keys(_utils2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _utils2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _utils2[key];
+    }
+  });
+});

package/dist/runtime/index.mjs

@@ -0,0 +1,3 @@
+export * from "./utils/index.mjs";
+export * from "./app/composables/index.mjs";
+export * from "@docus/mdc/utils";

package/dist/runtime/navigation.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Fetch and update navigation with latest changes
+ */
+export declare function generateNavigation(contents?: any[]): Promise<any>;