@dou-ui/sheet 0.0.0-stage → 0.1.0-alpha.0

package/dist/use-comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-comments.js","names":[],"sources":["../src/use-comments.ts"],"sourcesContent":["import { applyCommentAction, type CommentAction, type CommentThread } from 'dou-ui'\nimport { computed, onMounted, shallowRef, watch, type ComputedRef, type Ref } from 'vue'\nimport type { SheetPoint } from './core/address'\nimport { sheetCommentAnchors, type SheetCommentAnchor } from './core/comments'\nimport type { SheetCommentsProvider } from './core/extension'\nimport type { SheetWorkbook } from './core/model'\nimport { sheetKey, type SheetTransaction, type SheetTransactionMeta } from './core/transaction'\nimport type { SheetEmits, SheetProps } from './types'\n\ntype Emit = <K extends keyof SheetEmits>(event: K, ...args: SheetEmits[K]) => void\n\n/** Whether a thread shows: known and not resolved. */\nconst isOpen = (thread: CommentThread | undefined) => !!thread && !thread.resolved\n\n/** A cell of a sheet, by the sheet's key. */\nexport interface SheetCommentCell extends SheetPoint {\n  sheet: string\n}\n\n/**\n * The comment threads of a sheet: which one is open beside its cell, the\n * cell a new one is being written for, and the changes made from the card.\n */\nexport function useSheetComments(options: {\n  props: SheetProps\n  emit: Emit\n  provider: ComputedRef<SheetCommentsProvider | null>\n  doc: Readonly<Ref<SheetWorkbook>>\n  /** The cell a thread on `point` of the sheet shown goes on: a merge's top left. */\n  home: (point: SheetPoint) => SheetPoint\n  /** The key of the sheet shown. */\n  shown: () => string\n  transact: (\n    run: (tr: SheetTransaction) => void,\n    meta?: SheetTransactionMeta,\n  ) => SheetTransaction | null\n}) {\n  const { props, emit, provider, doc, home, shown, transact } = options\n\n  const threads = computed<readonly CommentThread[]>(\n    () => provider.value?.threads.value ?? props.comments ?? [],\n  )\n  // comparing with an older version shows the cells only\n  const enabled = computed(\n    () => (!!provider.value || props.comments !== undefined) && !props.compare,\n  )\n  const writable = computed(() => enabled.value && !!props.author && props.commentable !== false)\n  const byId = computed(() => new Map(threads.value.map((thread) => [thread.id, thread])))\n\n  // the shared document's threads, mirrored to `v-model:comments`; from the\n  // mount on, when the extensions have the grid to work with\n  onMounted(() =>\n    watch(\n      () => provider.value?.threads.value,\n      (value) => value && emit('update:comments', [...value]),\n      { immediate: true },\n    ),\n  )\n\n  const innerActive = shallowRef<string | null>(null)\n  const active = computed(() =>\n    props.activeComment === undefined ? innerActive.value : props.activeComment,\n  )\n  function open(id: string | null) {\n    if (id === active.value) return\n    innerActive.value = id\n    emit('update:activeComment', id)\n  }\n\n  /** The cell a new thread is being written for. */\n  const pending = shallowRef<SheetCommentCell | null>(null)\n  /** Bumped to put the cursor in the card's reply box. */\n  const focusRequest = shallowRef(0)\n\n  /** The thread a cell of the sheet shown names; `undefined` when it names none (or one not known). */\n  function threadAt(point: SheetPoint) {\n    const at = home(point)\n    const cell = doc.value.sheets.find((sheet) => sheetKey(sheet) === shown())?.cells[at.row]?.[\n      at.col\n    ]\n    const id = cell && typeof cell === 'object' ? cell.comment : undefined\n    return id ? byId.value.get(id) : undefined\n  }\n\n  const anchors = computed(() => (enabled.value ? sheetCommentAnchors(doc.value) : new Map()))\n\n  /** Where the card is: the cell being commented on, or the open thread's. */\n  const cell = computed<SheetCommentCell | null>(() => {\n    if (pending.value) return pending.value\n    const id = active.value\n    const anchor = id ? anchors.value.get(id) : undefined\n    return anchor ? { sheet: anchor.sheet, row: anchor.row, col: anchor.col } : null\n  })\n\n  /**\n   * The thread about a cell of the sheet shown, ready to reply to; or the\n   * box to start one. `false` when there is neither.\n   */\n  function start(point: SheetPoint): boolean {\n    if (!enabled.value) return false\n    const at = home(point)\n    const thread = threadAt(at)\n    if (thread) {\n      pending.value = null\n      open(thread.id)\n      focusRequest.value++\n      return true\n    }\n    if (!writable.value) return false\n    open(null)\n    pending.value = { sheet: shown(), ...at }\n    focusRequest.value++\n    return true\n  }\n\n  /** Opens the open thread on a cell just clicked, or closes the card when it has none. */\n  function show(point: SheetPoint) {\n    if (!enabled.value) return\n    const thread = threadAt(point)\n    pending.value = null\n    open(isOpen(thread) ? thread!.id : null)\n  }\n\n  function close() {\n    pending.value = null\n    open(null)\n  }\n\n  const meta = { history: false, action: 'comment' } as const\n\n  function apply(action: CommentAction) {\n    if (action.type === 'create') {\n      const at = pending.value\n      if (!at) return\n      transact((tr) => tr.setComment(at, action.thread.id), meta)\n      pending.value = null\n    } else if (action.type === 'remove') {\n      const anchor = anchors.value.get(action.threadId)\n      if (anchor) transact((tr) => tr.setComment(anchor, undefined), meta)\n    }\n    if (provider.value) provider.value.apply(action)\n    else emit('update:comments', applyCommentAction(threads.value, action))\n    emit('commentAction', action)\n    if (action.type === 'create') {\n      open(action.thread.id)\n      focusRequest.value++\n    } else if (action.type === 'remove' || action.type === 'resolve') open(null)\n  }\n\n  function getAnchors(): Record<string, SheetCommentAnchor | null> {\n    const found = sheetCommentAnchors(doc.value)\n    return Object.fromEntries(\n      threads.value.map((thread) => [thread.id, found.get(thread.id) ?? null]),\n    )\n  }\n\n  return {\n    enabled,\n    writable,\n    threads,\n    byId,\n    active,\n    pending,\n    cell,\n    focusRequest,\n    threadAt,\n    isOpen,\n    start,\n    show,\n    open,\n    close,\n    apply,\n    getAnchors,\n  }\n}\n\nexport type SheetComments = ReturnType<typeof useSheetComments>\n"],"mappings":";;;;;;AAYA,IAAM,UAAU,WAAsC,CAAC,CAAC,UAAU,CAAC,OAAO;;;;;AAW1E,SAAgB,iBAAiB,SAa9B;CACD,MAAM,EAAE,OAAO,MAAM,UAAU,KAAK,MAAM,OAAO,aAAa;CAE9D,MAAM,UAAU,eACR,SAAS,OAAO,QAAQ,SAAS,MAAM,YAAY,CAAC,CAC5D;CAEA,MAAM,UAAU,gBACP,CAAC,CAAC,SAAS,SAAS,MAAM,aAAa,KAAA,MAAc,CAAC,MAAM,OACrE;CACA,MAAM,WAAW,eAAe,QAAQ,SAAS,CAAC,CAAC,MAAM,UAAU,MAAM,gBAAgB,KAAK;CAC9F,MAAM,OAAO,eAAe,IAAI,IAAI,QAAQ,MAAM,KAAK,WAAW,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC;CAIvF,gBACE,YACQ,SAAS,OAAO,QAAQ,QAC7B,UAAU,SAAS,KAAK,mBAAmB,CAAC,GAAG,KAAK,CAAC,GACtD,EAAE,WAAW,KAAK,CACpB,CACF;CAEA,MAAM,cAAc,WAA0B,IAAI;CAClD,MAAM,SAAS,eACb,MAAM,kBAAkB,KAAA,IAAY,YAAY,QAAQ,MAAM,aAChE;CACA,SAAS,KAAK,IAAmB;EAC/B,IAAI,OAAO,OAAO,OAAO;EACzB,YAAY,QAAQ;EACpB,KAAK,wBAAwB,EAAE;CACjC;;CAGA,MAAM,UAAU,WAAoC,IAAI;;CAExD,MAAM,eAAe,WAAW,CAAC;;CAGjC,SAAS,SAAS,OAAmB;EACnC,MAAM,KAAK,KAAK,KAAK;EACrB,MAAM,OAAO,IAAI,MAAM,OAAO,MAAM,UAAU,SAAS,KAAK,MAAM,MAAM,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI,GACvF,GAAG;EAEL,MAAM,KAAK,QAAQ,OAAO,SAAS,WAAW,KAAK,UAAU,KAAA;EAC7D,OAAO,KAAK,KAAK,MAAM,IAAI,EAAE,IAAI,KAAA;CACnC;CAEA,MAAM,UAAU,eAAgB,QAAQ,QAAQ,oBAAoB,IAAI,KAAK,oBAAI,IAAI,IAAI,CAAE;;CAG3F,MAAM,OAAO,eAAwC;EACnD,IAAI,QAAQ,OAAO,OAAO,QAAQ;EAClC,MAAM,KAAK,OAAO;EAClB,MAAM,SAAS,KAAK,QAAQ,MAAM,IAAI,EAAE,IAAI,KAAA;EAC5C,OAAO,SAAS;GAAE,OAAO,OAAO;GAAO,KAAK,OAAO;GAAK,KAAK,OAAO;EAAI,IAAI;CAC9E,CAAC;;;;;CAMD,SAAS,MAAM,OAA4B;EACzC,IAAI,CAAC,QAAQ,OAAO,OAAO;EAC3B,MAAM,KAAK,KAAK,KAAK;EACrB,MAAM,SAAS,SAAS,EAAE;EAC1B,IAAI,QAAQ;GACV,QAAQ,QAAQ;GAChB,KAAK,OAAO,EAAE;GACd,aAAa;GACb,OAAO;EACT;EACA,IAAI,CAAC,SAAS,OAAO,OAAO;EAC5B,KAAK,IAAI;EACT,QAAQ,QAAQ;GAAE,OAAO,MAAM;GAAG,GAAG;EAAG;EACxC,aAAa;EACb,OAAO;CACT;;CAGA,SAAS,KAAK,OAAmB;EAC/B,IAAI,CAAC,QAAQ,OAAO;EACpB,MAAM,SAAS,SAAS,KAAK;EAC7B,QAAQ,QAAQ;EAChB,KAAK,OAAO,MAAM,IAAI,OAAQ,KAAK,IAAI;CACzC;CAEA,SAAS,QAAQ;EACf,QAAQ,QAAQ;EAChB,KAAK,IAAI;CACX;CAEA,MAAM,OAAO;EAAE,SAAS;EAAO,QAAQ;CAAU;CAEjD,SAAS,MAAM,QAAuB;EACpC,IAAI,OAAO,SAAS,UAAU;GAC5B,MAAM,KAAK,QAAQ;GACnB,IAAI,CAAC,IAAI;GACT,UAAU,OAAO,GAAG,WAAW,IAAI,OAAO,OAAO,EAAE,GAAG,IAAI;GAC1D,QAAQ,QAAQ;EAClB,OAAO,IAAI,OAAO,SAAS,UAAU;GACnC,MAAM,SAAS,QAAQ,MAAM,IAAI,OAAO,QAAQ;GAChD,IAAI,QAAQ,UAAU,OAAO,GAAG,WAAW,QAAQ,KAAA,CAAS,GAAG,IAAI;EACrE;EACA,IAAI,SAAS,OAAO,SAAS,MAAM,MAAM,MAAM;OAC1C,KAAK,mBAAmB,mBAAmB,QAAQ,OAAO,MAAM,CAAC;EACtE,KAAK,iBAAiB,MAAM;EAC5B,IAAI,OAAO,SAAS,UAAU;GAC5B,KAAK,OAAO,OAAO,EAAE;GACrB,aAAa;EACf,OAAO,IAAI,OAAO,SAAS,YAAY,OAAO,SAAS,WAAW,KAAK,IAAI;CAC7E;CAEA,SAAS,aAAwD;EAC/D,MAAM,QAAQ,oBAAoB,IAAI,KAAK;EAC3C,OAAO,OAAO,YACZ,QAAQ,MAAM,KAAK,WAAW,CAAC,OAAO,IAAI,MAAM,IAAI,OAAO,EAAE,KAAK,IAAI,CAAC,CACzE;CACF;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}

package/dist/use-messages.js

@@ -0,0 +1,29 @@
+import { sheetMessagesFor } from "./locale.js";
+import { useLocale } from "dou-ui";
+import { computed, toValue } from "vue";
+// src/use-messages.ts
+/**
+* The spreadsheet's texts, picked by the name of DouUI's current locale.
+* Pass `messages` to override any of them.
+*/
+function useSheetMessages(override) {
+	const { locale } = useLocale();
+	return computed(() => {
+		const base = sheetMessagesFor(locale.value.name);
+		const extra = toValue(override);
+		if (!extra) return base;
+		const out = { ...base };
+		for (const [key, value] of Object.entries(extra)) {
+			if (value === void 0) continue;
+			const own = base[key];
+			out[key] = own && typeof own === "object" ? {
+				...own,
+				...value
+			} : value;
+		}
+		return out;
+	});
+}
+export { useSheetMessages };
+
+//# sourceMappingURL=use-messages.js.map

package/dist/use-messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-messages.js","names":[],"sources":["../src/use-messages.ts"],"sourcesContent":["import { useLocale } from 'dou-ui'\nimport { computed, toValue, type MaybeRefOrGetter } from 'vue'\nimport { sheetMessagesFor, type SheetMessages, type SheetMessagesOverride } from './locale'\n\n/**\n * The spreadsheet's texts, picked by the name of DouUI's current locale.\n * Pass `messages` to override any of them.\n */\nexport function useSheetMessages(override?: MaybeRefOrGetter<SheetMessagesOverride | undefined>) {\n  const { locale } = useLocale()\n  return computed<SheetMessages>(() => {\n    const base = sheetMessagesFor(locale.value.name)\n    const extra = toValue(override)\n    if (!extra) return base\n    const out: Record<string, unknown> = { ...base }\n    for (const [key, value] of Object.entries(extra)) {\n      if (value === undefined) continue\n      // groups, such as error reasons or function help, can be given one by one\n      const own = base[key as keyof SheetMessages]\n      out[key] = own && typeof own === 'object' ? { ...own, ...(value as object) } : value\n    }\n    return out as unknown as SheetMessages\n  })\n}\n"],"mappings":";;;;;;;;AAQA,SAAgB,iBAAiB,UAAgE;CAC/F,MAAM,EAAE,WAAW,UAAU;CAC7B,OAAO,eAA8B;EACnC,MAAM,OAAO,iBAAiB,OAAO,MAAM,IAAI;EAC/C,MAAM,QAAQ,QAAQ,QAAQ;EAC9B,IAAI,CAAC,OAAO,OAAO;EACnB,MAAM,MAA+B,EAAE,GAAG,KAAK;EAC/C,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,GAAG;GAChD,IAAI,UAAU,KAAA,GAAW;GAEzB,MAAM,MAAM,KAAK;GACjB,IAAI,OAAO,OAAO,OAAO,QAAQ,WAAW;IAAE,GAAG;IAAK,GAAI;GAAiB,IAAI;EACjF;EACA,OAAO;CACT,CAAC;AACH"}

package/package.json

@@ -1,6 +1,95 @@
 {
   "name": "@dou-ui/sheet",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0-alpha.0",
+  "description": "DouUI 的电子表格：可编辑的单元格网格、公式与协同",
+  "keywords": [
+    "vue",
+    "vue3",
+    "spreadsheet",
+    "sheet",
+    "grid",
+    "table"
+  ],
+  "license": "MIT",
+  "author": "daidr <daidr@daidr.me>",
+  "homepage": "https://github.com/daidr/dou-ui#readme",
+  "bugs": "https://github.com/daidr/dou-ui/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/daidr/dou-ui.git",
+    "directory": "packages/sheet"
+  },
+  "type": "module",
+  "sideEffects": [
+    "*.css",
+    "./dist/style.js",
+    "./dist/*/style.js"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./formula": {
+      "types": "./dist/types/formula/index.d.ts",
+      "import": "./dist/formula/index.js"
+    },
+    "./core": {
+      "types": "./dist/types/core/index.d.ts",
+      "import": "./dist/core/index.js"
+    },
+    "./collaboration": {
+      "types": "./dist/types/collaboration/index.d.ts",
+      "import": "./dist/collaboration/index.js"
+    },
+    "./code": {
+      "types": "./dist/types/code/index.d.ts",
+      "import": "./dist/code/index.js"
+    },
+    "./code/style": {
+      "types": "./dist/code/style.d.ts",
+      "import": "./dist/code/style.js"
+    },
+    "./style": {
+      "types": "./dist/style.d.ts",
+      "import": "./dist/style.js"
+    },
+    "./style.css": "./dist/style.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build && vue-tsc -p tsconfig.build.json && bun scripts/build-style.ts"
+  },
+  "peerDependencies": {
+    "@dou-ui/code": "0.1.0-alpha.0",
+    "dou-ui": "0.1.0-alpha.0",
+    "vue": "^3.5.0",
+    "yjs": "^13.6.0"
+  },
+  "peerDependenciesMeta": {
+    "@dou-ui/code": {
+      "optional": true
+    },
+    "yjs": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@dou-ui/icons": "0.1.0-alpha.0",
+    "@dou-ui/theme": "0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "@dou-ui/code": "0.1.0-alpha.0",
+    "y-protocols": "^1.0.7",
+    "yjs": "^13.6.33"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}