Clean up document

[mojosoeun]

What this PR does / why we need it?

Clean up document

Any background context you want to provide?

This is a process for pruning d.ts file and then generating cleaned up document files

I referenced firebase-js-sdk https://github.com/firebase/firebase-js-sdk/blob/master/repo-scripts/prune-dts/prune-dts.ts
and https://github.com/microsoft/rushstack/blob/master/build-tests/api-extractor-scenarios/src/runScenarios.ts

What are the relevant tickets?

Fixes #181

Checklist

• Added relevant tests or not required
• Didn't break anything

[codecov]

Codecov Report

Merging #218 (0e2a68d) into main (80cdc8f) will not change coverage.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #218   +/-   ##
=======================================
  Coverage   79.68%   79.68%           
=======================================
  Files          49       49           
  Lines        2820     2820           
  Branches      469      469           
=======================================
  Hits         2247     2247           
  Misses        404      404           
  Partials      169      169           

Impacted Files	Coverage Δ
src/core/client.ts	75.90% <ø> (ø)
src/document/document.ts	82.82% <ø> (ø)
src/document/json/array.ts	83.33% <ø> (ø)
src/document/json/element.ts	88.23% <ø> (ø)
src/document/json/object.ts	82.00% <ø> (ø)
src/document/json/plain_text.ts	83.67% <ø> (ø)
src/document/json/rich_text.ts	70.10% <ø> (ø)
src/document/time/ticket.ts	82.85% <ø> (ø)
src/api/converter.ts	81.81% <100.00%> (ø)
src/document/json/rga_tree_list.ts	85.60% <100.00%> (ø)
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 80cdc8f...0e2a68d. Read the comment docs.

[hackerwins]

Thank you for the contribution. We can now manipulate documents in more detail.

I left a minor request.

[dc7303]

Thanks for the detailed explanation, it was easier to review. 😄
I was worried about using the firebase-js-sdk code, so I left a comment, so please check it.

[hackerwins]

Is there a reason we removed prepare? Previously, if the user installs yorkie-js-sdk with npm install, prepare is preparing bundles(yorkie-js-sdk.js, yorkie-js-sdk.d.ts).

https://docs.npmjs.com/cli/v7/using-npm/scripts#life-cycle-scripts

[mojosoeun]

I took a look this script https://github.com/yorkie-team/yorkie-js-sdk/blob/main/.github/workflows/npm-publish.yml
I think after we run npm run build, I think yorkie-js-sdk.js, yorkie-js-sdk.d.ts are generated. isn't it? 🤔

[hackerwins]

This script was previously added when removing the /dist folder from the source code. I remember that without the script there was no dist file after npm install from the specific branch directly(e.g. npm install https://github.com/yorkie-team/yorkie-js-sdk#main). 🤔

https://stackoverflow.com/questions/17509669/how-to-install-an-npm-package-from-github-directly

[mojosoeun]

I see thank you for letting me know!

[hackerwins]

LGTM 👍

[mojosoeun]

@hackerwins In the generated docs, could you let me know the part which we should remove? For example, constructor, symbol.iterators(), etc.. After we merge this pr, I'm going to create a new pr for this!