superdoc 2.2.1 → 2.3.0

package/package.json

@@ -1,31 +1,144 @@
 {
   "name": "superdoc",
-  "version": "2.2.1",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "mocha -r should test/",
-    "watch": "npm run test -- -watch",
-    "start": "nodemon utils/server"
+  "type": "module",
+  "version": "2.3.0",
+  "license": "AGPL-3.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/superdoc/docx-editor.git",
+    "directory": "packages/superdoc"
   },
-  "author": "Simone Busoli",
-  "license": "MIT",
-  "peerDependencies": {
-    "supertest": "^2.0.0"
+  "homepage": "https://www.superdoc.dev/",
+  "bugs": {
+    "url": "https://github.com/superdoc/docx-editor/issues"
   },
-  "devDependencies": {
-    "body-parser": "^1.15.1",
-    "mocha": "^3.0.2",
-    "nodemon": "^1.9.2",
-    "should": "^11.1.0",
-    "supertest": "^2.0.0"
+  "readme": "../../README.md",
+  "files": [
+    "dist",
+    "dist-cdn",
+    "AGENTS.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "exports": {
+    ".": {
+      "types": {
+        "import": "./dist/superdoc/src/public/index.d.ts",
+        "require": "./dist/superdoc/src/public/index.d.cts"
+      },
+      "import": "./dist/superdoc.es.js",
+      "require": "./dist/superdoc.cjs"
+    },
+    "./ui": {
+      "types": {
+        "import": "./dist/superdoc/src/public/ui.d.ts",
+        "require": "./dist/superdoc/src/public/ui.d.cts"
+      },
+      "import": "./dist/public/ui.es.js",
+      "require": "./dist/public/ui.cjs"
+    },
+    "./ui/react": {
+      "types": {
+        "import": "./dist/superdoc/src/public/ui-react.d.ts",
+        "require": "./dist/superdoc/src/public/ui-react.d.cts"
+      },
+      "import": "./dist/public/ui-react.es.js",
+      "require": "./dist/public/ui-react.cjs"
+    },
+    "./collaboration-upgrade-engine": {
+      "types": {
+        "import": "./dist/superdoc/src/public/collaboration-upgrade-engine.d.ts",
+        "require": "./dist/superdoc/src/public/collaboration-upgrade-engine.d.cts"
+      },
+      "node": {
+        "import": "./dist/collaboration-upgrade-engine.es.js",
+        "require": "./dist/collaboration-upgrade-engine.cjs"
+      }
+    },
+    "./style.css": "./dist/style.css",
+    "./style.layered.css": "./dist/style.layered.css"
   },
+  "types": "./dist/superdoc/src/public/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "ui": [
+        "./dist/superdoc/src/public/ui.d.ts"
+      ],
+      "ui/react": [
+        "./dist/superdoc/src/public/ui-react.d.ts"
+      ],
+      "collaboration-upgrade-engine": [
+        "./dist/superdoc/src/public/collaboration-upgrade-engine.d.ts"
+      ]
+    }
+  },
+  "main": "./dist/superdoc.cjs",
+  "module": "./dist/superdoc.es.js",
   "dependencies": {
-    "connect-livereload": "^0.5.4",
-    "ejs": "^2.4.1",
-    "express": "^4.14.0",
-    "express-ejs-layouts": "^2.1.0",
-    "livereload": "^0.5.0",
-    "lodash": "^4.12.0"
+    "@superdoc/docx-engine": "0.2.0",
+    "@types/mdast": "^4.0.4",
+    "@types/ws": "^8.18.1",
+    "buffer-crc32": "^1.0.0",
+    "eventemitter3": "^5.0.1",
+    "jsdom": "^27.3.0",
+    "konva": "^10.2.0",
+    "pinia": "^2.1.7",
+    "rollup-plugin-copy": "^3.5.0",
+    "uuid": "^11.1.1",
+    "vue": "^3.5.0",
+    "y-websocket": "^3.0.0"
+  },
+  "peerDependencies": {
+    "@hocuspocus/provider": "^2.13.6",
+    "@liveblocks/client": "^3.15.5",
+    "@liveblocks/yjs": "^3.15.5",
+    "pdfjs-dist": "^5.4.296",
+    "react": ">=16.8.0",
+    "yjs": "^13.6.19"
+  },
+  "peerDependenciesMeta": {
+    "@liveblocks/client": {
+      "optional": true
+    },
+    "@liveblocks/yjs": {
+      "optional": true
+    },
+    "pdfjs-dist": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "dev": "vite",
+    "dev:orbit": "SUPERDOC_V2_RUNTIME_MODE=source vite",
+    "devapp:build": "SUPERDOC_V2_RUNTIME_MODE=source vite build --config vite.config.devapp.js",
+    "devapp:preview": "vite preview --config vite.config.devapp.js --port 9096 --strictPort",
+    "watch:orbit": "SUPERDOC_V2_RUNTIME_MODE=source vite build --watch",
+    "smoke:v2-resolver": "node ./scripts/smoke-v2-runtime-mode.mjs",
+    "predev:collab": "node ../../scripts/free-port.mjs 9094 && node ../../scripts/free-port.mjs ${SUPERDOC_DEV_COLLAB_PORT:-8081}",
+    "dev:collab": "concurrently -k -n VITE,COLLAB -c cyan,green \"vite\" \"pnpm run collab-server\"",
+    "collab-server": "pnpm --filter @superdoc-dev/superdoc-yjs-collaboration build && tsx src/dev/collab-server.ts",
+    "build": "pnpm run build:npm && pnpm run build:cdn",
+    "build:npm": "node ../../scripts/build-private-v2-if-present.mjs && vite build && pnpm run build:collaboration-upgrade-engine && pnpm run verify:npm",
+    "build:dev": "SUPERDOC_SKIP_DTS=1 vite build",
+    "build:collaboration-upgrade-engine": "vite build --config vite.config.collaboration-upgrade-engine.js",
+    "verify:npm": "node ./scripts/check-tsconfig-type-surface.cjs && node ./scripts/ensure-types.cjs && node ./scripts/audit-npm-bundle.cjs && node ./scripts/audit-collaboration-upgrade-engine.cjs && node ./scripts/audit-declarations.cjs && node ./scripts/check-export-coverage.cjs && node ./scripts/verify-public-facade-emit.cjs && node ./scripts/check-private-core.cjs && node ./scripts/report-declaration-reachability.cjs && node ./scripts/link-engine-styles.cjs && pnpm run audit:publish",
+    "audit:publish": "node ../../scripts/audit-publish-artifact.mjs dist --label superdoc-dist --superdoc",
+    "audit:declarations": "node ./scripts/audit-declarations.cjs",
+    "audit:declarations:informational": "node ./scripts/audit-declarations.cjs --informational",
+    "check:jsdoc": "node ./scripts/check-jsdoc.cjs",
+    "check:v2-only": "node ./scripts/check-private-core.cjs",
+    "build:es": "pnpm run build",
+    "watch:es": "vite build --watch",
+    "build:cdn": "node ../../scripts/build-private-v2-if-present.mjs && vite build --config vite.config.cdn.js && pnpm run verify:cdn",
+    "verify:cdn": "node ../../scripts/audit-publish-artifact.mjs dist-cdn --label superdoc-cdn && node ./scripts/audit-cdn-separation.cjs",
+    "watch:cdn": "vite build --watch --config vite.config.cdn.js",
+    "clean": "rm -rf dist dist-cdn",
+    "pack:local": "pnpm run pack:es",
+    "pack:dist": "node ./scripts/pack-output.cjs clean && pnpm run build:es && node ./scripts/pack-with-restore.cjs && node ./scripts/pack-output.cjs finalize",
+    "pack:es": "node ./scripts/pack-output.cjs clean && pnpm run build:es && node ./scripts/pack-with-restore.cjs && node ./scripts/pack-output.cjs finalize && node ../../scripts/audit-publish-artifact.mjs superdoc.tgz --label superdoc-tarball --superdoc",
+    "test": "vitest"
   }
-}
+}

package/.npmignore

@@ -1,4 +0,0 @@
-node_modules/
-.idea/
-web/data.json
-npm-debug.log

package/data.json

@@ -1,17 +0,0 @@
-{
- "options": {
-  "apiPrefix": "",
-  "output": "./data.json"
- },
- "methods": [
-  {
-   "name": "json",
-   "description": "whatever",
-   "responseDescription": "",
-   "arguments": {},
-   "response": {},
-   "errors": {},
-   "warnings": []
-  }
- ]
-}

package/index.js

@@ -1,2 +0,0 @@
-module.exports.start = options => new (require('./lib/Runner'))(options)
-module.exports.web = options => require('./web')(options)

package/lib/Augmenter.js

@@ -1,27 +0,0 @@
-function Augmenter (constructor) {
-  this.constructor = constructor
-  this.originals = {}
-}
-
-Augmenter.prototype.augment = function (key, augment) {
-  var original = this.constructor.prototype[key]
-
-  this.originals[key] = original
-  this.constructor.prototype[key] = augment(original)
-}
-
-Augmenter.prototype.reset = function () {
-  var self = this
-
-  Object.keys(this.originals).forEach(function (key) {
-    var original = self.originals[key]
-
-    if (original) {
-      self.constructor.prototype[key] = original
-    } else {
-      delete self.constructor.prototype[key]
-    }
-  })
-}
-
-module.exports = Augmenter

package/lib/Runner.js

@@ -1,80 +0,0 @@
-var url = require('url'),
-    _ = require('lodash'),
-    querystring = require('querystring'),
-    supertest = require('supertest'),
-    Test = supertest.Test,
-    Augmenter = require('./Augmenter'),
-    Stopper = require('./Stopper')
-
-function Runner (options) {
-  var self = this
-
-  this.methods = []
-  this.options = _.merge({
-    apiPrefix: '',
-    output: './data.json'
-  }, options)
-
-  var augmenter = new Augmenter(Test)
-
-  augmenter.augment('assert', function (original) {
-    return function () {
-      self.map(this)
-      original.apply(this, arguments)
-    }
-  })
-
-  augmenter.augment('describe', function () {
-    return function (description) {
-      this._superdoc_description = description
-      return this
-    }
-  })
-
-  augmenter.augment('describeArgs', function () {
-    return function (description) {
-      this._superdoc_argumentDescription = description
-      return this
-    }
-  })
-
-  augmenter.augment('describeErrors', function () {
-    return function (description) {
-      this._superdoc_errorDescription = description
-      return this
-    }
-  })
-
-  augmenter.augment('describeResponse', function () {
-    return function (description) {
-      this._superdoc_responseDescription = description
-      return this
-    }
-  })
-
-  return new Stopper(this, augmenter)
-}
-
-Runner.prototype.map = function (test) {
-  var request = test.request(),
-      response = test.response,
-      requestUrl = url.parse(request.path),
-      prefixRegexp = new RegExp('^' + escapeRegExp(this.options.apiPrefix))
-
-  this.methods.push({
-    name: requestUrl.pathname.replace(prefixRegexp, '').replace(/^\//, ''),
-    description: test._superdoc_description || '',
-    responseDescription: test._superdoc_responseDescription || '',
-    arguments: requestUrl.query ? querystring.parse(requestUrl.query) : test._data,
-    argumentDescription: test._superdoc_argumentDescription || {},
-    errorDescription: test._superdoc_errorDescription || {},
-    response: /text/.test(response.type) ? response.text : response.body
-  })
-}
-
-// http://stackoverflow.com/questions/3446170/escape-string-for-use-in-javascript-regex
-function escapeRegExp (str) {
-  return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
-}
-
-module.exports = Runner

package/lib/Stopper.js

@@ -1,71 +0,0 @@
-var _ = require('lodash'),
-    writeFileSync = require('fs').writeFileSync
-
-function Stopper (runner, augmenter) {
-  var stop = function () {
-    augmenter.reset()
-    reduce()
-  }
-
-  stop.methods = runner.methods
-
-  return stop
-
-  function reduce () {
-    let methods = _(runner.methods)
-        .groupBy('name')
-        .mapValues((methods, name) => {
-          let argumentExample = _.mapValues(
-              _.merge.apply({}, _(methods)
-                  .filter(m => m.response.ok)
-                  .map('arguments')
-                  .value()),
-              value => ({example: value}))
-
-          let argumentDescription = _.mapValues(
-              _.merge.apply({}, _(methods)
-                  .map('argumentDescription')
-                  .value()),
-              value => ({description: value}))
-
-          let argumentRequired = _.mapValues(
-              _.merge.apply({}, _(methods)
-                  .map('arguments')
-                  .value()),
-              (value, key) => ({
-                required: _(methods)
-                    .filter(m => m.response.ok)
-                    .map('arguments')
-                    .every(args => _.has(args, key))
-              }))
-
-          let errorDescription = _.merge.apply({}, _(methods)
-              .map('errorDescription')
-              .value())
-
-          return {
-            name,
-            description: _(methods).map('description').compact().first() || '',
-            responseDescription: _(methods).map('responseDescription').compact().first() || '',
-            arguments: _.merge({}, argumentExample, argumentDescription, argumentRequired),
-            response: _.merge.apply({}, _(methods).map('response').filter({ok: true}).value()),
-            errors: _(methods)
-                .map('response.error').compact().uniq()
-                .map(e => [e, errorDescription[e] || ''])
-                .fromPairs()
-                .value(),
-            warnings: _(methods).map('response.warning').compact().uniq().value()
-          }
-        })
-        .values()
-        .sortBy('name')
-        .value()
-
-    writeFileSync(
-        runner.options.output,
-        JSON.stringify({options: runner.options, methods: methods}, null, 1)
-    )
-  }
-}
-
-module.exports = Stopper

package/test/superdoc.js

@@ -1,126 +0,0 @@
-var should = require('should'),
-    app = require('./../utils/app'),
-    superdoc = require('..'),
-    request = require('supertest')(app),
-    docs
-
-beforeEach(function () {
-  docs = superdoc.start()
-})
-
-afterEach(function () {
-  docs()
-})
-
-describe('methods', function () {
-
-  it('should track name', function (done) {
-    request
-        .get('/hello')
-        .expect('hello')
-        .end(function (err) {
-          if (err) return done(err)
-          docs.methods.length.should.equal(1)
-          docs.methods[0].name.should.equal('hello')
-          done()
-        })
-  })
-
-  it('should track name with querystring', function (done) {
-    request
-        .get('/hello?world=1')
-        .expect('hello')
-        .end(function (err) {
-          if (err) return done(err)
-          docs.methods.length.should.equal(1)
-          docs.methods[0].name.should.equal('hello')
-          done()
-        })
-  })
-
-  it('should track description', function (done) {
-    request
-        .get('/hello')
-        .describe('whatever')
-        .expect('hello')
-        .end(function (err) {
-          if (err) return done(err)
-
-          docs.methods.length.should.equal(1)
-          docs.methods[0].description.should.equal('whatever')
-          done()
-        })
-  })
-
-  it('should track arguments in querystring', function (done) {
-    request
-        .get('/hello?hello=world')
-        .describe('whatever')
-        .expect('hello')
-        .end(function (err) {
-          if (err) return done(err)
-
-          should.config.checkProtoEql = false;
-          docs.methods.should.have.length(1)
-          should(docs.methods[0].arguments).be.eql({hello: 'world'})
-          done()
-        })
-  })
-
-  it('should track arguments in body', function (done) {
-    request
-        .post('/json')
-        .send({hello: 'world'})
-        .describe('whatever')
-        .expect({hello: 'world'})
-        .end(function (err) {
-          if (err) return done(err)
-
-          docs.methods.should.have.length(1)
-          docs.methods[0].arguments.should.deepEqual({hello: 'world'})
-          done()
-        })
-  })
-
-  it('should track arguments descriptions', function (done) {
-    request
-        .post('/json')
-        .send({hello: 'world'})
-        .describeArgs({hello: 'some argument'})
-        .expect({hello: 'world'})
-        .end(function (err) {
-          if (err) return done(err)
-
-          docs.methods.length.should.equal(1)
-          docs.methods[0].argumentDescription.should.deepEqual({hello: 'some argument'})
-          done()
-        })
-  })
-
-  it('should track text response', function (done) {
-    request
-        .get('/hello')
-        .describe('whatever')
-        .expect('hello')
-        .end(function (err) {
-          if (err) return done(err)
-          docs.methods.length.should.equal(1)
-          docs.methods[0].response.should.equal('hello')
-          done()
-        })
-  })
-
-  it('should track json response', function (done) {
-    request
-        .get('/json')
-        .describe('whatever')
-        .expect({hello: 'world'})
-        .end(function (err) {
-          if (err) return done(err)
-          docs.methods.length.should.equal(1)
-          docs.methods[0].response.should.deepEqual({hello: 'world'})
-          done()
-        })
-  })
-
-})

package/utils/app.js

@@ -1,18 +0,0 @@
-var express = require('express'),
-    path = require('path'),
-    bodyParser = require('body-parser'),
-    web = require('../').web,
-    app = express()
-
-app.use('/docs', web({
-  fileName: path.join(__dirname, '..', 'data.json'),
-  liveReload: true
-}))
-
-app.use(bodyParser.json())
-
-app.get('/hello', (req, res) => res.send('hello'))
-app.get('/json', (req, res) => res.json({hello: 'world'}))
-app.post('/json', (req, res) => res.json(req.body))
-
-module.exports = app

package/utils/server.js

@@ -1,2 +0,0 @@
-require('./app').listen(3001)
-

package/web/index.js

@@ -1,54 +0,0 @@
-let path = require('path')
-let livereload = require('livereload')
-let _ = require('lodash')
-let readFileSync = require('fs').readFileSync
-let express = require('express')
-let ejsLayouts = require("express-ejs-layouts")
-
-function makeApp (options) {
-  let app = express()
-
-  app.set('view engine', 'ejs')
-  app.set('views', path.join(__dirname, 'views'))
-
-  app.use(ejsLayouts)
-  app.use(express.static(path.join(__dirname, 'public')))
-
-  app.use((req, res, next) => {
-    res.locals.docs = JSON.parse(readFileSync(options.fileName))
-    next()
-  })
-
-  if (options.liveReload) {
-    app.use(require('connect-livereload')({
-      port: options.liveReloadPort
-    }))
-  }
-
-  app.get('/', (req, res) => {
-    let groups = _.groupBy(res.locals.docs.methods, method => method.name.split('.')[0])
-
-    res.render('index', {options: res.locals.docs.options, groups})
-  })
-
-  app.get('/:method', (req, res) => {
-    let method = _.find(res.locals.docs.methods, {name: req.params.method})
-
-    res.render('method', {
-      mountpath: app.mountpath,
-      options: res.locals.docs.options,
-      method
-    })
-  })
-
-  if (options.liveReload) {
-    livereload.createServer({
-      exts: ['json'],
-      port: options.liveReloadPort
-    }).watch(path.dirname(options.fileName))
-  }
-
-  return app
-}
-
-module.exports = makeApp

package/web/public/style.css

@@ -1,76 +0,0 @@
-body {
-    background: #f9f9f9;
-    font-family: 'Open Sans', serif;
-    margin: 0;
-    padding: 0;
-    box-sizing: border-box;
-}
-
-.container {
-    width: 800px;
-    margin: 0 auto;
-}
-
-.content {
-    background-color: #fff;
-    border-radius: .25rem;
-    box-shadow: 0 1px 0 rgba(0, 0, 0, .25);
-    padding: 2rem 2rem 1rem;
-    margin: 0 auto 2rem;
-    position: relative;
-    border: 1px solid #e8e8e8;
-}
-
-table {
-    border-collapse: collapse;
-    border-spacing: 0;
-    margin: 0 0 1rem;
-    width: 100%;
-}
-
-table tr {
-    vertical-align: top;
-    border-bottom: 1px solid #e8e8e8;
-}
-
-table td, table th {
-    padding: .5rem 1rem .5rem 0;
-}
-
-table td.example {
-  max-width: 250px;
-  white-space: nowrap;
-  overflow: hidden;
-  text-overflow: ellipsis;
-}
-
-table tr:first-child th:not(:only-of-type) {
-    font-weight: 700;
-    border-bottom: 2px solid #2ab27b;
-    text-align: left;
-}
-
-table tr:last-child {
-    border-bottom: none;
-}
-
-pre {
-    margin: 0 0 1rem;
-    white-space: pre;
-    overflow: hidden;
-    text-overflow: ellipsis;
-    font-size: .875rem;
-    font-family: Monaco, Menlo, Consolas, "Courier New", monospace !important;
-    border: 1px solid #E8E8E8;
-    padding: .1rem .4rem;
-    border-radius: .2rem;
-}
-
-pre code {
-    background: 0 0;
-    border: none;
-    padding: 0;
-    color: #555459;
-    font-size: inherit;
-    white-space: pre;
-}