@pcg/dynamic-components 1.0.0-alpha.2 → 1.0.0-alpha.4

package/package.json

@@ -1,15 +1,27 @@
 {
   "name": "@pcg/dynamic-components",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.4",
   "description": "Dynamic components with Yjs integration for collaborative editing",
+  "license": "MIT",
+  "author": {
+    "email": "code@deepvision.team",
+    "name": "DeepVision Code"
+  },
+  "contributors": [
+    "Vitaliy Angolenko <v.angolenko@deepvision.software>",
+    "Sergii Sadovyi <s.sadovyi@deepvision.software>"
+  ],
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
     "@tiptap/core": "^2.12.0",
     "y-prosemirror": "^1.3.4",
     "yjs": "^13.6.27",
-    "@pcg/predicates": "1.0.0-alpha.1"
+    "@pcg/predicates": "1.0.0-alpha.2"
   },
   "devDependencies": {
     "@tiptap/pm": "^2.12.0",
@@ -25,6 +37,6 @@
     "build": "tsdown",
     "test": "vitest run",
     "test:watch": "vitest",
-    "lint": "eslint \"src/**/*.ts\""
+    "lint": "eslint \"src/**/*.ts\" --fix"
   }
 }

package/.turbo/turbo-build.log

@@ -1,16 +0,0 @@
-
-
-> @pcg/dynamic-components@1.0.0-alpha.0 build /Users/vangolenko/node/pcg/packages/dynamic-components
-> tsdown
-
-ℹ tsdown v0.15.12 powered by rolldown v1.0.0-beta.45
-ℹ Using tsdown config: /Users/vangolenko/node/pcg/packages/dynamic-components/tsdown.config.ts
-ℹ entry: src/index.ts
-ℹ tsconfig: tsconfig.lib.json
-ℹ Build start
-ℹ Cleaning 3 files
-ℹ dist/index.js       57.84 kB │ gzip: 12.05 kB
-ℹ dist/index.js.map  120.49 kB │ gzip: 25.12 kB
-ℹ dist/index.d.ts     60.94 kB │ gzip: 11.28 kB
-ℹ 3 files, total: 239.28 kB
-✔ Build complete in 1141ms

package/CHANGELOG.md

@@ -1,24 +0,0 @@
-# @pcg/dynamic-components
-
-## 1.0.0-alpha.2
-
-### Patch Changes
-
-- Updated dependencies
-  - @pcg/predicates@1.0.0-alpha.1
-
-## 1.0.0-alpha.1
-
-### Patch Changes
-
-- 72f7749: feat(ui): 🔄 make repeatable collection heading optional and add draggability
-
-  - Makes the `heading` prop optional in `DRepeatableCollection` interface
-  - Adds new `draggable` boolean prop to support drag-and-drop functionality
-  - Improves component flexibility for different use cases
-
-## 1.0.0
-
-### Minor Changes
-
-- Initial release of dynamic-components package with Yjs integration for collaborative editing

package/eslint.config.cjs

@@ -1,14 +0,0 @@
-//
-// @pkg 📦 DeepVision ESLint Config [NestJS]
-// @version 📍 1.0.0
-// @author 🐳 DeepVision Team <code@deepvision.team>
-//
-// Documentation reference: https://eslint.org/docs/user-guide/configuring/
-// ESLint versions: https://eslint.org/blog/
-//
-// eslint-disable-next-line @typescript-eslint/no-require-imports, node/no-unpublished-require
-const deep = require('@deepvision/eslint-plugin');
-
-module.exports = [
-  ...deep.default.configs.node,
-];

package/src/assertions/basic.ts

@@ -1,7 +0,0 @@
-export {
-  isCallable,
-  isIndex,
-  isNullOrUndefined,
-  isNumber,
-  isString,
-} from '@pcg/predicates';

package/src/assertions/containers.ts

@@ -1,8 +0,0 @@
-export {
-  entriesOf,
-  isContainerValue,
-  isEmptyArray,
-  isEmptyContainer,
-  isObject,
-  keysOf,
-} from '@pcg/predicates';

package/src/assertions/index.ts

@@ -1,6 +0,0 @@
-export * from './basic.js';
-export * from './containers.js';
-export * from './paths.js';
-export * from './rich-text.js';
-export * from './yjs.js';
-

package/src/assertions/paths.ts

@@ -1,12 +0,0 @@
-/**
- * Checks if two paths are equal.
- * @param {(string | number)[]} path - The first path to compare.
- * @param {(string | number)[]} toPath - The second path to compare.
- * @returns {boolean} Returns true if both paths are of the same length and all corresponding elements are equal, false otherwise.
- * @example
- * isEqualPath(['items', 'id:xxx', 'name'], ['items', 'id:xxx', 'name']);  // Returns true
- * isEqualPath(['items', 'id:yyy', 'name'], ['items', 'id:xxx', 'name']);  // Returns false
- */
-export const isEqualPath = (path: (string | number)[], toPath: (string | number)[]) => {
-  return path.length === toPath.length && path.every((v, index) => v === toPath[index]);
-};

package/src/assertions/rich-text.ts

@@ -1,16 +0,0 @@
-import { RichText } from '@/data-objects/rich-text.js';
-
-/**
- * Checks if the given value is a RichText object.
- * @param {unknown} value - The value to check.
- * @returns {boolean} Returns true if `value` is a RichText object, false otherwise.
- * @example
- * isRichText({ id: 'xx', ... type: 'RichText' });  // Returns true
- */
-export const isRichText = (value: unknown): value is RichText => {
-  if (typeof value === 'object' && value !== null) {
-    return 'type' in value && value.type === 'RichText';
-  }
-
-  return false;
-};

package/src/assertions/yjs.ts

@@ -1,25 +0,0 @@
-import * as Y from 'yjs';
-
-/**
- * Checks if the given value is a Yjs Map.
- * @param {unknown} yMap - The value to check.
- * @returns {boolean} Returns true if `yMap` is a Yjs Map, false otherwise.
- * @example
- * const yMap = new Y.Map();
- * isYMap(yMap);  // Returns true
- */
-export const isYMap = <T = unknown>(yMap: unknown): yMap is Y.Map<T> => {
-  return yMap instanceof Y.Map;
-};
-
-/**
- * Checks if the given value is a Yjs Array.
- * @param {unknown} yArray - The value to check.
- * @returns {boolean} Returns true if `yArray` is a Yjs Array, false otherwise.
- * @example
- * const yArray = new Y.Array();
- * isYArray(yArray);  // Returns true
- */
-export const isYArray = <T = unknown>(yArray: unknown): yArray is Y.Array<T> => {
-  return yArray instanceof Y.Array;
-};

package/src/data-objects/data-object.ts

@@ -1,34 +0,0 @@
-/**
- * The BaseDataObject interface represents a basic structure of a data object.
- * It includes an `id` and a `type` string.
- *
- * @interface
- * @example
- * {
- *   id: 'xxx',
- *   tiptap: { ... },
- *   type: 'RichText'
- * }
- */
-export interface BaseDataObject {
-  /**
-   * The unique identifier for the data object.
-   */
-  id: string;
-
-  /**
-   * The type of the data object. It's used for differentiating different types of data objects.
-   */
-  type: string;
-}
-
-/**
- * Gets the key of the data object. The key is a string combining `type` and `id` of the data object, separated by a colon.
- * @param {BaseDataObject} dataObject - The data object to get the key from.
- * @returns {string} Returns the key of the data object.
- * @example
- * getDataObjectKey({ id: 'xxx', type: 'RichText' });  // Returns 'RichText:xxx'
- */
-export const getDataObjectKey = (dataObject: BaseDataObject): string => {
-  return `${dataObject.type}:${dataObject.id}`;
-};

package/src/data-objects/index.ts

@@ -1,3 +0,0 @@
-export * from './data-object.js';
-export * from './rich-text.js';
-

package/src/data-objects/rich-text.ts

@@ -1,38 +0,0 @@
-import { JSONContent } from '@tiptap/core';
-
-import { BaseDataObject } from './data-object.js';
-
-/**
- * The RichText interface represents a rich text data object.
- *
- * @interface
- * @example
- * {
- *   id: 'xx',
- *   tiptap: { ... },
- *   html: '<p>...</p>',
- *   plaintext: '...',
- *   type: 'RichText'
- * }
- */
-export interface RichText extends BaseDataObject {
-  /**
-   * The TipTap JSON content of the rich text data object.
-   */
-  tiptap?: JSONContent;
-
-  /**
-   * The HTML representation of the rich text data object.
-   */
-  html?: string;
-
-  /**
-   * The plaintext representation of the rich text data object.
-   */
-  plaintext?: string;
-
-  /**
-   * The type of the rich text data object, set to 'RichText'.
-   */
-  type: 'RichText';
-}

package/src/dynamic-components/fractional-indexing.ts

@@ -1,321 +0,0 @@
-// License: CC0 (no rights reserved).
-
-// This is based on https://observablehq.com/@dgreensp/implementing-fractional-indexing
-
-export const BASE_62_DIGITS =
-  '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
-
-const SMALLEST_INTEGER = 'A00000000000000000000000000';
-
-const INTEGER_ZERO = 'a0';
-
-// `a` may be empty string, `b` is null or non-empty string.
-// `a < b` lexicographically if `b` is non-null.
-// no trailing zeros allowed.
-// digits is a string such as '0123456789' for base 10.  Digits must be in
-// ascending character code order!
-/**
- * @param {string} a
- * @param {string | null} b
- * @param {string} digits
- * @returns {string}
- */
-const midpoint = (a: string, b: string | null, digits: string): string => {
-  if (b !== null && a >= b) {
-    throw new Error(a + ' >= ' + b);
-  }
-  if (a.slice(-1) === '0' || (b && b.slice(-1) === '0')) {
-    throw new Error('trailing zero');
-  }
-  if (b) {
-    // remove longest common prefix.  pad `a` with 0s as we
-    // go.  note that we don't need to pad `b`, because it can't
-    // end before `a` while traversing the common prefix.
-    let n = 0;
-    while ((a[n] || '0') === b[n]) {
-      n++;
-    }
-    if (n > 0) {
-      return b.slice(0, n) + midpoint(a.slice(n), b.slice(n), digits);
-    }
-  }
-  // first digits (or lack of digit) are different
-  const digitA = a ? digits.indexOf(a[0]) : 0;
-  const digitB = b !== null ? digits.indexOf(b[0]) : digits.length;
-  if (digitB - digitA > 1) {
-    const midDigit = Math.round(0.5 * (digitA + digitB));
-
-    return digits[midDigit];
-  } else {
-    // first digits are consecutive
-    if (b && b.length > 1) {
-      return b.slice(0, 1);
-    }
-
-    // `b` is null or has length 1 (a single digit).
-    // the first digit of `a` is the previous digit to `b`,
-    // or 9 if `b` is null.
-    // given, for example, midpoint('49', '5'), return
-    // '4' + midpoint('9', null), which will become
-    // '4' + '9' + midpoint('', null), which is '495'
-    return digits[digitA] + midpoint(a.slice(1), null, digits);
-  }
-};
-
-/**
- * @param {string} int
- * @return {void}
- */
-
-const validateInteger = (int: string) => {
-  if (int.length !== getIntegerLength(int[0])) {
-    throw new Error('invalid integer part of order key: ' + int);
-  }
-};
-
-/**
- * @param {string} head
- * @return {number}
- */
-
-const getIntegerLength = (head: string): number => {
-  if (head >= 'a' && head <= 'z') {
-    return head.charCodeAt(0) - 'a'.charCodeAt(0) + 2;
-  } else if (head >= 'A' && head <= 'Z') {
-    return 'Z'.charCodeAt(0) - head.charCodeAt(0) + 2;
-  } else {
-    throw new Error('invalid order key head: ' + head);
-  }
-};
-
-/**
- * @param {string} key
- * @return {string}
- */
-
-const getIntegerPart = (key: string) => {
-  const integerPartLength = getIntegerLength(key[0]);
-  if (integerPartLength > key.length) {
-    throw new Error('invalid order key: ' + key);
-  }
-
-  return key.slice(0, integerPartLength);
-};
-
-/**
- * @param {string} key
- * @return {void}
- */
-
-const validateOrderKey = (key: string) => {
-  if (key === SMALLEST_INTEGER) {
-    throw new Error('invalid order key: ' + key);
-  }
-  // getIntegerPart will throw if the first character is bad,
-  // or the key is too short.  we'd call it to check these things
-  // even if we didn't need the result
-  const i = getIntegerPart(key);
-  const f = key.slice(i.length);
-  if (f.slice(-1) === '0') {
-    throw new Error('invalid order key: ' + key);
-  }
-};
-
-// note that this may return null, as there is a largest integer
-/**
- * @param {string} x
- * @param {string} digits
- * @return {string | null}
- */
-const incrementInteger = (x: string, digits: string) => {
-  validateInteger(x);
-  const [head, ...digs] = x.split('');
-  let carry = true;
-  for (let i = digs.length - 1; carry && i >= 0; i--) {
-    const d = digits.indexOf(digs[i]) + 1;
-    if (d === digits.length) {
-      digs[i] = '0';
-    } else {
-      digs[i] = digits[d];
-      carry = false;
-    }
-  }
-  if (carry) {
-    if (head === 'Z') {
-      return 'a0';
-    }
-    if (head === 'z') {
-      return null;
-    }
-    const h = String.fromCharCode(head.charCodeAt(0) + 1);
-    if (h > 'a') {
-      digs.push('0');
-    } else {
-      digs.pop();
-    }
-
-    return h + digs.join('');
-  } else {
-    return head + digs.join('');
-  }
-};
-
-// note that this may return null, as there is a smallest integer
-/**
- * @param {string} x
- * @param {string} digits
- * @return {string | null}
- */
-
-const decrementInteger = (x: string, digits: string) => {
-  validateInteger(x);
-  const [head, ...digs] = x.split('');
-  let borrow = true;
-  for (let i = digs.length - 1; borrow && i >= 0; i--) {
-    const d = digits.indexOf(digs[i]) - 1;
-    if (d === -1) {
-      digs[i] = digits.slice(-1);
-    } else {
-      digs[i] = digits[d];
-      borrow = false;
-    }
-  }
-  if (borrow) {
-    if (head === 'a') {
-      return 'Z' + digits.slice(-1);
-    }
-    if (head === 'A') {
-      return null;
-    }
-    const h = String.fromCharCode(head.charCodeAt(0) - 1);
-    if (h < 'Z') {
-      digs.push(digits.slice(-1));
-    } else {
-      digs.pop();
-    }
-
-    return h + digs.join('');
-  } else {
-    return head + digs.join('');
-  }
-};
-
-// `a` is an order key or null (START).
-// `b` is an order key or null (END).
-// `a < b` lexicographically if both are non-null.
-// digits is a string such as '0123456789' for base 10.  Digits must be in
-// ascending character code order!
-/**
- * @param {string | null} a
- * @param {string | null} b
- * @param {string=} digits
- * @return {string}
- */
-export const generateKeyBetween = (a: string | null, b: string | null, digits = BASE_62_DIGITS) => {
-  if (a !== null) {
-    validateOrderKey(a);
-  }
-  if (b !== null) {
-    validateOrderKey(b);
-  }
-  if (a !== null && b !== null && a >= b) {
-    throw new Error(a + ' >= ' + b);
-  }
-  if (a === null) {
-    if (b === null) {
-      return INTEGER_ZERO;
-    }
-
-    const ib = getIntegerPart(b);
-    const fb = b.slice(ib.length);
-    if (ib === SMALLEST_INTEGER) {
-      return ib + midpoint('', fb, digits);
-    }
-    if (ib < b) {
-      return ib;
-    }
-    const res = decrementInteger(ib, digits);
-    if (res === null) {
-      throw new Error('cannot decrement any more');
-    }
-
-    return res;
-  }
-
-  if (b === null) {
-    const ia = getIntegerPart(a);
-    const fa = a.slice(ia.length);
-    const i = incrementInteger(ia, digits);
-
-    return i === null ? ia + midpoint(fa, null, digits) : i;
-  }
-
-  const ia = getIntegerPart(a);
-  const fa = a.slice(ia.length);
-  const ib = getIntegerPart(b);
-  const fb = b.slice(ib.length);
-  if (ia === ib) {
-    return ia + midpoint(fa, fb, digits);
-  }
-  const i = incrementInteger(ia, digits);
-  if (i === null) {
-    throw new Error('cannot increment any more');
-  }
-  if (i < b) {
-    return i;
-  }
-
-  return ia + midpoint(fa, null, digits);
-};
-
-/**
- * same preconditions as generateKeysBetween.
- * n >= 0.
- * Returns an array of n distinct keys in sorted order.
- * If a and b are both null, returns [a0, a1, ...]
- * If one or the other is null, returns consecutive "integer"
- * keys.  Otherwise, returns relatively short keys between
- * a and b.
- * @param {string | null} a
- * @param {string | null} b
- * @param {number} n
- * @param {string} digits
- * @return {string[]}
- */
-export const generateNKeysBetween = (a: string | null, b: string | null, n: number, digits = BASE_62_DIGITS): string[] => {
-  if (n === 0) {
-    return [];
-  }
-  if (n === 1) {
-    return [generateKeyBetween(a, b, digits)];
-  }
-  if (b === null) {
-    let c = generateKeyBetween(a, b, digits);
-    const result = [c];
-    for (let i = 0; i < n - 1; i++) {
-      c = generateKeyBetween(c, b, digits);
-      result.push(c);
-    }
-
-    return result;
-  }
-  if (a === null) {
-    let c = generateKeyBetween(a, b, digits);
-    const result = [c];
-    for (let i = 0; i < n - 1; i++) {
-      c = generateKeyBetween(a, c, digits);
-      result.push(c);
-    }
-    result.reverse();
-
-    return result;
-  }
-  const mid = Math.floor(n / 2);
-  const c = generateKeyBetween(a, b, digits);
-
-  return [
-    ...generateNKeysBetween(a, c, mid, digits),
-    c,
-    ...generateNKeysBetween(c, b, n - mid - 1, digits),
-  ];
-};

package/src/dynamic-components/index.ts

@@ -1,6 +0,0 @@
-export { generateKeyBetween } from './fractional-indexing.js';
-export * from './paths.js';
-export * from './registry/index.js';
-export * from './tools.js';
-export * from './types.js';
-