From 28f445fbe0994f8bb1c3303db4b98ec0536fcc10 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Tue, 26 Jul 2022 17:32:16 -0400 Subject: [PATCH 1/8] readme changes --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++----- logo-banner2.png | Bin 0 -> 12980 bytes 2 files changed, 46 insertions(+), 5 deletions(-) create mode 100644 logo-banner2.png diff --git a/README.md b/README.md index 102228b..3630a9e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,52 @@ -# DynamicPDF Cloud API - Node.js Client +![](./logo-banner2.png) -A NodeJS Client API that uses the DynamicPDF Cloud API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. +# Node.js Client (`nodejs-client`) -For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage") +The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage"). Examples using this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub"). Support for other languages/platforms can be found on [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub") -Examples for this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub") +## Documentation -Support for other languages/platforms can be found at [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub") +* Obtain overview documentation for the DynamicPDF Cloud API Client libraries from the [Cloud API Users Guide](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/cloud-api-client-libraries). +* Access the documentation for each particular endpoint from the following Users Guide pages. +| Endpoint | REST Endpoint | REST Endpoint Client Library | Description | +| ------------- | ------------------------------------------------------------ | ----------------------------------------- | ------------------------------------------------------------ | +| `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](./cloud-api-dlex-layout) | [`dlex-layout`](./client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | +| `image-info` | [Cloud API Users Guide - `image-info`](./cloud-api-image-info) | [`image-info`](./client-api-image-info) | Returns image metadata as a JSON document. | +| `pdf` | [Cloud API Users Guide - `pdf`](./cloud-api-pdf) | [`pdf`](./client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | +| `pdf-info` | [Cloud API Users Guide - `pdf-Info`](./cloud-api-pdf-info) | [`pdf-info`](./client-api-pdf-info) | Returns PDF metadata as a JSON document. | +| `pdf-text` | [Cloud API Users Guide - `pdf-text`](./cloud-api-pdf-text) | [`pdf-text`](./client-api-pdf-text) | Returns the text from a PDF as a JSON document. | +| `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](./cloud-api-pdf-xmp) | [`pdf-xmp`](./client-api-pdf-xmp) | Returns XMP metadata from a PDF. | +## REST Client + +* The nodejs-client uses the node.js built-in HTTP module (https://nodejs.dev/learn/the-nodejs-http-module). + +## Tutorials + +* The following lists the tutorials provided by DynamicPDF Cloud API that illustrate using the API's endpoints. +* Obtain the project, [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples) to view complete worked examples for each of the following tutorials + +| Tutorial | Endpoint/Tool | Sample Project | Description | +| ------------------------------------------------------------ | ------------- | ------------------------------------------- | ------------------------------------------------------------ | +| [Merging PDFs](./cloud-api/merging-pdfs) | `pdf` | Merge PDFs (pdf endpoint) | Use the `pdf` endpoint to merge three pre-existing `pdf` documents. | +| [Completing an Acroform](./cloud-api/form-completion) | `pdf` | Fill an Acroform (pdf endpoint) | Use the `pdf` endpoint to fill-out a pre-existing PDF form with values and save the resulting PDF. | +| [Creating a PDF from DLEX (`pdf` Endpoint)](./cloud-api/dlex-pdf-endpoint) | `pdf` | Create a PDF (pdf endpoint) | Use the `pdf` endpoint to generate a PDF report using DLEX. Then merge two PDF documents and then append the merged PDFs to the PDF created using the DLEX report. | +| [Adding Bookmarks to a PDF](./cloud-api/bookmarks) | `pdf` | Add Bookmarks (pdf endpoint) | Use the Outline element in JSON instructions with the `pdf` endpoint to create a PDF that includes bookmarks. | +| [Creating a PDF from DLEX (`dlex-layout` Endpoint)](./cloud-api/dlex-layout) | `dlex-layout` | Create a PDF (dlex-layout endpoint) | Use the `dlex-layout` endpoint to create PDF reports dynamically on the cloud. | +| [Get Image Metadata](./cloud-api/image-info) | `image-info` | Get Image Information (image-info endpoint) | Use the `image-info` endpoint to get metadata describing an image. | +| [Extract PDF Metadata](./cloud-api/pdf-info) | `pdf-info` | Get PDF Information (pdf-info endpoint) | The `pdf-info` endpoint returns metadata from a PDF document. | +| [Extract PDF Text](./cloud-api/pdf-text) | `pdf-text` | Extract Text (pdf-text endpoint) | Extract text from PDF documents using the `pdf-text` endpoint. | +| [Extract XMP Metadata](./cloud-api/pdf-xmp) | `pdf-xmp` | Get XMP Metadata (pdf-xmp endpoint) | Extract XMP meta-data from PDF documents using the `pdf-xmp` endpoint. | + +# Support + +The primary source for the DynamicPDF Cloud API support is through [Stack Overflow](https://stackoverflow.com/questions/tagged/dynamicpdf-api). Please use the "[dynamicpdf-api](https://stackoverflow.com/questions/tagged/dynamicpdf-api)" tag to ask questions. Our support team actively monitors the tag and responds promptly to any questions. Also, let us know you asked the question by following up with an email to [support@dynamicpdf.com](mailto:support@dynamicpdf.com). + +## Pro Plan Subscribers[#](https://cloud.dynamicpdf.com/support#pro-plan-subscribers) + +Ticket support is available to Pro Plan subscribers. But we still encourage you to help the community by posting on Stack Overflow when possible. You can also email [support@dynamicpdf.com](mailto:support@dynamicpdf.com) if you need to ask something specific to your use case that may not help the DynamicPDF Cloud API community. + +# License + +The `nodejs-client` library is licensed under the [MIT License](./LICENSE). diff --git a/logo-banner2.png b/logo-banner2.png new file mode 100644 index 0000000000000000000000000000000000000000..aeb1403c8e86df7f5c2ff43a1fb42b2320224956 GIT binary patch literal 12980 zcmeHrcTiN@^6n4>BxfWK2ngzshnzE#GYA61FytW)S)$}98AOmQIZ6fzf+$(Z2uP41 zk~0GGHlB0OJ-6PgdUfmF-}~!Q#jZVT_4-!#x4Kt%??_E`MFLzJTo4FEpsXaP4FaLb z0PiX|SitkvMBE|>gm2@cYlzZ@d4io?ovdsf5MY$IGXjk8vb6$%yk-m2?OpE*6NX$L zlDlEPl?v`-I*XX5-P%8uRX%wm9vAuDsH8Bltn3WLOBRW{-f`W$L}bc}Akb@R`1JUj zo+7>Xf$Yi;=&N1wABR_McK+9o%tpfPb~7)7yKCBhjh~1V#UJj{O2pY7sQ6PWOoqRMt3|UD7ySjQ zfQwd-yv9)PN5iiRNY6Q0J18|TlVme4H=eFDo1|xd4PE(mSi_2bpz~6~>>0%qGrOz( zJT9a2%VUV~YF7E4xbds+kgvgW67iDRM9Tid{bWDQ_Vahm&VQWqncCp(8y{V{?M_~7 zWjq<2#c}s_+Jr}sa8<(L6R#&bKR@1j8p8DRkfANbn^JSyMSi9Ivr-0XUUy8LZyuGs z@+g{h@~O@NhC`x*7p)wM|GZw8rJme(SezBTgvF-z$iz;7_qp7G zRYG&>=MS+~uU;7Y_;3y-3eyY4rzhOzAjsyRe!)_vk0#lE|IQ2Tf+(dV&ik@f4=My~ zD~{LlgnYk4QQs?0EB%g2I3@aFEH&V z)sWLBoz@eqWfgBxu~5$iL_TBd_FMOOaSaiv@8fr0XZat+@NsFjvd;OeHhigCa9OvW zT(G?wxDc#OT`(HZD7x(al>r?-`NbpWDoip$eS096jdwx(7D&W*IIrk&o%OIArD7OG zqEUg@u*X46LYI$rYNmuM)xm@O?B?qSPPtQD-UHVHZe2R3nHd-M3;zAH9__{&?@b>b z<-A9~XtJ_eWvq`{v6ZK(MWIv^XdUbw9$Fu+u$88g?9M!fC^qVaIM)4a8R?Imfaoti z)68+4RXcroq5g>+hl|OQ1BWi3M2tG^{B+@iF&}eRlR|=J^w07L-5#^46S{Y&WY;HW z!o(SdL)v7Tybl>Ca~+gMqjX$DFH-w;7Kl;{Ge2b93%2;tn9w|We54m)P=V>V-aEC` zaAY~6HShr}Rb8{#HJby^s+g-JYaUmEEKA!EHrrNTVHSez+GL zt*646Q#x-`9zh^LnynZ@L7traV|W}f<@w|nNZ3*F-uQCo{3c6F06)tOktivVjvI_C43pHo_sg~Zwc z2U{*$KVClFKq*v!f>*jjOP(lo-1o(TR%lJTdeEm!gI>%OIW&1?rS~^2d;o<>u+g|_ z@uOxa2APvdXvxR;s-==M*jp`hCK`*lGsA*&oa0ASy+OwY#TbIEFW_SEq<8r`~C>O2MO&?4>Z%n_9djnMW8u7L*>la3~6iCrzD;kXHvMWQx7n$ayx zZlGV!X*{tV-Ckw>e8xS;;t!I6$5EpnB@oLvw?9Nw$haHXG|fE|oMx?^H|ip}RaN6(fX63W zNtDITGHR51ltj{v)z_K%d zym6e&bPz3aObTv@s~54IZ#-3|M5C*BLcOk}$eF9>yNOmviz3{jpQy=JLrt@1DC@Po zzPCLT2wHP2aKRwXlaRh;Rj}o?6ha&mBU@mFpLW-+u=@KKaffoVYD5ty7-zBbqxXuz z{G0m==#il{eX(pLk!jB<+RLiUF2vSPs$Q-jZ=_IluJLY%b^~iXC%a` zU?)kEQTD=R+7q9~v#?d!duvFJi8=L5c<3w?+LayJ7WO&FQQwc;%x}~)khN*-@Pn9s zsEoM{S-?!Mnn`HR4|S`%l=MXY9(i3WYzrUf3N+Pd(CtxRoMZO%Qc!>kycQ3NBKU2|`|1f~QYWgtdOZ98bJ6FaV zB>k_;X=Q2x4625qJv5L!95CaSagcYg&S?a#sp=WpV{+d-{KvP`F&zl)q=!Xh!u%f0 z`x14qq1mB=6QV02&S<(G2#VDFrO+G>ex+pC)1UZlky3Ygix<|@PwCr zN*Dx*1(JOtL180Y-jIJIv87v}X;3qc8_V(h^2D6KJF!ih*}^-Ag*R&w%HPkjaKQPl zYH|%>Ji5~!p(DvW_A<>|qYZn7DSng~Jz||tyQgtI*&mrNfiqZFlQ8Pt^a0;POjBkk z{~opagG&~_5jLrT(Tx~Svw}E62cIjv5BniCZzA|53?FozP$)#Em>e?K zQJk=Eew-mPkFBJn+tei8OfFYSd8g@|n4MC;DdN4eW(r>3uEyODL?_o$2v5*7$KlUc zVA=@=-=|a+>p6Fe_*?9%tqzcjJ2Q@q@koV_u>NCHs)eXK^8&P`wW6KcjaZTS!uT!Q+wSV z2T?q0nG@{2m_?&+5e`04ID5~jzweVmNP4)e<{m`7&QI+>0FGKXYVVM z8l-9o_`(YjwE!Y&T2I_y$iH_PL`c)wK1~^*9+>e813HpxibCJ6?+;6pJPXXrXt35{ zR`gCTehwt?SZwRFyR(Mwd`aL>^pR>W12=!TcPQ99#AA+HtJ;3El_Gm_E@zzifK~;C zdiTn==TWZA{e960R)nk*UQc$cPL5?u3TRM6CpOVSzXk8fQ|QG=Lf#`$<`FXcfJeHl zl8C7`Q9A<9es^%j$)3}7j+J#(XR+?I}uP z=h&qtMD_JJILhOo4d6HzW`t6K-%KxT@btboLR76X; zFS37BROq&FkFX}OfcOYRq*?fgj`b+1eV4j@A-Udm9pia)w;+d1v8l<2)=$g;Du>LYd zg!@q0r=l=4K5zlKxZG0s(YJGzkbAE{CG4A${|lL1P}{3df~$dVjdOe_wkw+B$FRY& zPayLk?C?&*gxV>wh53nvFCEq|uC73nNv3U|A z@$y0d35c7wBMRmPadf+T1Mvrj9KsFmYU_-$b#esXV8Se%+)?7p%)mVOANnDk)ztoi zcXa!c1%MAOFPJkI4<|Pl63O-V6>cbb4*=v(h5nB#+;o9nnoAqu=H%`QN633198q`w z4q*xZYrV6(tHW<|Ea6-T2Luujbpv+g`IjvfmDM!=T5&^xwJp;5_bPzwf00DlTK$u( zf6?t`=C?V2R|Hu87w*4E|HJm*!hn>Tnuwee-2Fy9WjS%?oBc&Bo#3{XBEMhxEnqN9 zsFffD0pk{e@LLHXATT}{H$;%n3I-K|a$7<9;D3Wsc639*9N~x?C;*((7QnHDaYF?V z+%O2AB_9;R&u_sEv4HZxAXZjFRtNzE4+3f>@HYqzS6jdITXZfD#ns6^0AK zgdlv}a5#itNB{;A=0gZW5WG-69${_)n1ChEZzxN+h=P+V5(XTnEfQvp;Bt1f{ylL+ zxQMi-vN$s@C-*-`G#y|lD_{W-1GbKqPM&W6oYJ*LB6Lu&8$NjiphAK|`~redZeal) z9_T-X^bxLZfG^&l@^EwV@&2B($>oR|0aDC zK47sw4qeIC4cOoN_s}0PrGs$!j_}}F$K4Q zIa(ut`{PfC{l~cN|G^mq1-OMRcr6eRUMnaJ!VeV`f>`hgKp{|G9!qYx07Agh;tzlN z3*F7h3groNMMzr%JOW$+4*HubF#DfJ#qqD&c-kOt&H>sID*gWKX2ZR!$bdJo*387eg6+%732Efy!j7- zzaeHJ`28J%%lVr zB}6 zV7{|%Fq5a|d(uN&hxE!5VzGdjx(pardJu{9)al{=UB2~~e#0}qBfI7GC$ksnP~a~J zjI+#BM5Tu&P0SL4`5$=1Gp@}acOOI#xW7H5UkNsCA1t203HCyTatre@X55QP@T{bB z4b|S2cxsI;7jg#s-fhbgg(;nmS+`RyvUzXM;SD{2K zH$vHcHgrLfmOLzRT3;JD8jbz74&#iIu)1Nn8ky1D`$5!`8bJZw63wL|Y8I7X`SBba zkeOvFs^3);r?)|UxyNC`az#`7?xkLZ}j$)zhR z2t3&2q&Ir`N@F6@Axgu8))rpBI$v8-lVZa7iCF#E_!`qA&CMR*Met2gLxMrod`!4Y zUH%}DODK8O+m6`B$>4|`ClUbxf!tT8We&QA$u)#et;5w*IPjybzYAQeo6a+7vEl?j z?B;|IrCzCGdOodf8e_%*Wn>!URi)elf&JY?>hDVv&l}@R@Q4HYFw2Cnag5DIJzIs1 zp%r6k_fTlt83lv!-+#M3p*;g(v0jtC-+HS?4j0e>;M7nOiIzL1l=|Qf-G=SwLxm6= zk`8Z4GFctN7nssw4C(v|>FJ4~O$ApK!?>S%$ZNV%_hc93jpPX~#k@bL7^zjL5X(&& zg~Z0Hr5{d8KF=^7e7iC`8@Stj>+1~KGA>6?B2DUPUw!>2(ypcgRC>nuqIPHG1?{SY z==4lZc^;N0d56vbDdwkonX^WB4pq!A{kP{b62gHEMIuM+(i&L(v&Hg5p6_l2K5J$r zzsrKt%`PHtm|w&mK zwE6Lq*b-^3&g>r%p)e8~8yl~UspJH2;u90aX*c?WvtG7Z98p=zElN;n&qmg5t!?%A zx`t)2Q0HDyVyonQXM3h(*>IPqlbhMGRE$VUQ5id@aQuv$%(0^z70%+yN^EB*D8|Jz zpg>edRu;oGjxpSXvoCUvk=t!8+UwW(y6BVm$;rvRJ1cQUbymz?ld2Vm@(+Co&d=|; z$5C%?;GFX8q<`b;iJ>Z@ov;E`J9j;0d3sPIJq2lX!3Zbxi%+_T2c}HRH7yCLuZPaf zDZm%zG~0w$LKQ13I)42$Ec{VH*dBP0F$DNAk?cQF2PNZ4`%VVHRpn=^j4(DfU7` z&&>@}Ei1UT7VpMbo*ne0>I(YhN z9LgAotQZ2NI~nHCr;ef9ylN=7Sg-!Q;tbd(sp(BlSO~e2a+tcVCyhStBiz-wWz3*raHx zJ|dXA`i|8a2ZYlHCA(}_D(br9+<4~JIGWINt`YlRBotJ#Y)PWaiWduq#}-&fI9z9?M1F48?Q zL?4}>r=^S1UstS>Qaf}5Te~@xE7U8k2&m;5W!s4z0JCgx>J*HNrriHvrKSoDTn9r?B=l?9LMP+>>8k-}u@gNkc=kcmAI14HoG) zS7AcNk20pF5~PB^$aIQSC!2@ieHx3?`((vsW$>@aN3-ZPP56yY*Hx3kI-Z5O8m}bI z7O$o~cCSZscWXAEO+2o7<5NiL?S1ZLZ;QHMB0qkLTK# zM`I&*9IU5G8rr-M*;o>BL7mT;2#NR3={Z$$H5cbkEu7DkQWwrn#=`XOWzoEX7NfMR`E)xGS| zpO-yk8l7K!AJ*w}n!O!tc+%mYW#qZi7e95rG}&*7gJ&G^13JMjrV|*b{A;VE>Q~T< z%*P!zDZTd z`|RD%(@+XZ3hDb5wo|dHXDIRL!ootfI{QZ|YL1?J#kwrrZ;!4Xvauc=@-;2^p89LQ z-Z9Rz^=q^mveT~8T^`O71qB9SU@gyBzxwXnG2ODQ!WR4>l?#4cd-bJ?XL^`$mGt)8 zb1UEQfez;-=ENi&ttwp^@Z!o|uIkPHOR^b*iF}g~{XWYHB2O+ZJ<1OOzwY*yj9KGz zK0ux_kW*5W{A`Yo??RtNhG?2F^*-;ksbD>U8oZc1H6jCQ5q&Q2+y2?xTxkg5x!Y|a z1kO=U2;5W#^iNywe%@|!`INgjTbkHNrc>Mcq`Y^+o&55W4IKoW_S&$nu1Sy*OBic7 zhSP41NZ+~oo%rXA=Ace$ zde`P|EjBlC5AX|ltzD^$62kj@<{RTSb2Qm!+eR4u&w{e-&kq{8UGliT2mlX-121IM z7;vMMOQb3&*0`Ob>=3-YV)crS-;+EIrO6XQFHAT*-tjzL ze|6LsA#+LG;oV{P;_KBdFay?sSpXv7ba#qqZEdam-Rsx8ip_Gt{r!wQ}WhMF{6N*e7R}Qs(ttTe!cUGpEfYm`Rq78`gbB`08-{J72NE{iW5_$gT3-8cz+H z1;2HmK6RwIDu4=Nrgqju$3+y{>#m;G3(6iYXWpwV%_K!styKhnDXI~zT_ghwfbFSX1u%SQY<~AqI_T3RS zsi;&q`9wE9G12wzUB1rbfK$g+k!u)wB`ciM!(3z z!otTp7roJGs{X@u)+0+p#Wr-J9&{jL$_8StkxcvAgY~etJqq(90zqT;EqeCFyyvj+0dFKBM4`yu%y@c0#S)KM{>Cn7HHGclb3P{v2)3k!d^TKf9o zSj(I2>f(6J*uRq{U@)63I63)=kd9$QCx^5{=4`M%(GZ7wDjngRvGVHv!BOX@mvlgG z6Y~4{X5q{uo=WC;AOSzN<`%YB!~Kx3&ieYUoXzNBekn|B)l4)ul`=b4#9qZhnp+|WMNRU2Ox z>{@SSfK?}QU< zrgr@7)Jw>4&YT%?CG|(B_Fx~Ea!gC)v_2UD;gB^vvvnWeGx`A=0a9XQI8d_XAZ{m>(o{9K!s;WDL_vP?`}oN>gxZB5TxXi z1`1h9c?Gb*s{F8QS(`R9FHwW1I(bcsqmBf+6@n<29-+-vaRMgoR_4S2}<}uf$^+bPTEy0 z5uEQgGFUAl$BQY7&?btJru}vi4+=^{ji9N!wf?i{K*76b+Y&4Kl~uNg$J(p&4fP_v zr$zqz$zUGfh1biR1^DtZ6r|sA+9Ya$M8c5%5V! zj{1kH4@s!BOgjhf2$v82oP3pMv1+qSB+yF&1^1_^e)MbOH|@sdhHAueL>{pdeEh&C zl_V|?JEiQL8s-hghOp*+;4G9eZwGI*5j&c-8rs*4RX(;Du$gL?!M(1AI#3SQR)1G$ zCrt+9xW<0DQ4G>zj_mD<3+Ywp!($|O4JD1_n3+z0*()a^Hccc-mRFo|JD59*7`UO&qu}>`K*BNQ+`gCkg|BkE5$EGTIKPszC4@j5uWJ^K;(RSie$UEQzR1>`C5$}`G zSNDj3;tFdhoDC; Date: Wed, 27 Jul 2022 12:45:56 -0400 Subject: [PATCH 2/8] Update README.md --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 3630a9e..2c720b3 100644 --- a/README.md +++ b/README.md @@ -22,22 +22,21 @@ The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, for * The nodejs-client uses the node.js built-in HTTP module (https://nodejs.dev/learn/the-nodejs-http-module). -## Tutorials - -* The following lists the tutorials provided by DynamicPDF Cloud API that illustrate using the API's endpoints. -* Obtain the project, [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples) to view complete worked examples for each of the following tutorials - -| Tutorial | Endpoint/Tool | Sample Project | Description | -| ------------------------------------------------------------ | ------------- | ------------------------------------------- | ------------------------------------------------------------ | -| [Merging PDFs](./cloud-api/merging-pdfs) | `pdf` | Merge PDFs (pdf endpoint) | Use the `pdf` endpoint to merge three pre-existing `pdf` documents. | -| [Completing an Acroform](./cloud-api/form-completion) | `pdf` | Fill an Acroform (pdf endpoint) | Use the `pdf` endpoint to fill-out a pre-existing PDF form with values and save the resulting PDF. | -| [Creating a PDF from DLEX (`pdf` Endpoint)](./cloud-api/dlex-pdf-endpoint) | `pdf` | Create a PDF (pdf endpoint) | Use the `pdf` endpoint to generate a PDF report using DLEX. Then merge two PDF documents and then append the merged PDFs to the PDF created using the DLEX report. | -| [Adding Bookmarks to a PDF](./cloud-api/bookmarks) | `pdf` | Add Bookmarks (pdf endpoint) | Use the Outline element in JSON instructions with the `pdf` endpoint to create a PDF that includes bookmarks. | -| [Creating a PDF from DLEX (`dlex-layout` Endpoint)](./cloud-api/dlex-layout) | `dlex-layout` | Create a PDF (dlex-layout endpoint) | Use the `dlex-layout` endpoint to create PDF reports dynamically on the cloud. | -| [Get Image Metadata](./cloud-api/image-info) | `image-info` | Get Image Information (image-info endpoint) | Use the `image-info` endpoint to get metadata describing an image. | -| [Extract PDF Metadata](./cloud-api/pdf-info) | `pdf-info` | Get PDF Information (pdf-info endpoint) | The `pdf-info` endpoint returns metadata from a PDF document. | -| [Extract PDF Text](./cloud-api/pdf-text) | `pdf-text` | Extract Text (pdf-text endpoint) | Extract text from PDF documents using the `pdf-text` endpoint. | -| [Extract XMP Metadata](./cloud-api/pdf-xmp) | `pdf-xmp` | Get XMP Metadata (pdf-xmp endpoint) | Extract XMP meta-data from PDF documents using the `pdf-xmp` endpoint. | +## **Tutorials** + +The following table lists the tutorial project or file name. In Visual Studio each tutorial is it's own project. In the remaining client libraries each tutorial is its own individual class. + +| Tutorial Title | Project/File/Class | Tutorial Location | +| -------------------------------------------------- | ----------------------- | ------------------------------------------------------------ | +| Merging PDFs | MergePdfs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdfs | +| Completing an AcroForm | `CompletingAcroForm` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/form-completion | +| Creating a PDF Using a DLEX and the `pdf` Endpoint | `CreatingPdfDlex` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-pdf-endpoint | +| Adding Bookmarks to a PDF | `AddBookmarks` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/bookmarks | +| Creating a PDF Using the `dlex-layout` Endpoint | `CreatingPdfDlexLayout` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-layout | +| Extracting Image Metadata | `GetImageInfo` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/image-info | +| Extract PDF Metadata | `GetPdfInfo` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-info | +| Extracting PDF's Text | `ExtractingText` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-text | +| Extract XMP Metadata | `GetXmpMetaData` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-xmp | # Support @@ -46,7 +45,6 @@ The primary source for the DynamicPDF Cloud API support is through [Stack Overfl ## Pro Plan Subscribers[#](https://cloud.dynamicpdf.com/support#pro-plan-subscribers) Ticket support is available to Pro Plan subscribers. But we still encourage you to help the community by posting on Stack Overflow when possible. You can also email [support@dynamicpdf.com](mailto:support@dynamicpdf.com) if you need to ask something specific to your use case that may not help the DynamicPDF Cloud API community. - # License The `nodejs-client` library is licensed under the [MIT License](./LICENSE). From 8b24d5685f61e748252a8bd755f74550914efe81 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Wed, 27 Jul 2022 12:51:37 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2c720b3..18f9da1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,15 @@ # Node.js Client (`nodejs-client`) -The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage"). Examples using this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub"). Support for other languages/platforms can be found on [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub") +The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage"). Examples using this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub"). Support for other languages/platforms can be found on [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub"). + +## Installation + +To install the prebuilt binary, use [`npm`](https://docs.npmjs.com/). + +```bash +npm install nodejs-client +``` ## Documentation @@ -20,11 +28,11 @@ The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, for ## REST Client -* The nodejs-client uses the node.js built-in HTTP module (https://nodejs.dev/learn/the-nodejs-http-module). +* The `nodejs-client` uses the node.js built-in HTTP module (https://nodejs.dev/learn/the-nodejs-http-module). ## **Tutorials** -The following table lists the tutorial project or file name. In Visual Studio each tutorial is it's own project. In the remaining client libraries each tutorial is its own individual class. +The following table lists the tutorial project or file name. | Tutorial Title | Project/File/Class | Tutorial Location | | -------------------------------------------------- | ----------------------- | ------------------------------------------------------------ | From d0acfb65283ea139865662b81a0417b4f6042cd0 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Fri, 29 Jul 2022 14:03:36 -0400 Subject: [PATCH 4/8] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 18f9da1..db57dbd 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, for ## Installation -To install the prebuilt binary, use [`npm`](https://docs.npmjs.com/). +To install the prebuilt binary, use [`npm`](https://docs.npmjs.com/). Complete instructions can be found at [@dynamicpdf/api](https://www.npmjs.com/package/@dynamicpdf/api). To install for the first time, use the following command. ```bash -npm install nodejs-client +npm i @dynamicpdf/api ``` ## Documentation @@ -17,14 +17,14 @@ npm install nodejs-client * Obtain overview documentation for the DynamicPDF Cloud API Client libraries from the [Cloud API Users Guide](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/cloud-api-client-libraries). * Access the documentation for each particular endpoint from the following Users Guide pages. -| Endpoint | REST Endpoint | REST Endpoint Client Library | Description | -| ------------- | ------------------------------------------------------------ | ----------------------------------------- | ------------------------------------------------------------ | -| `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](./cloud-api-dlex-layout) | [`dlex-layout`](./client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | -| `image-info` | [Cloud API Users Guide - `image-info`](./cloud-api-image-info) | [`image-info`](./client-api-image-info) | Returns image metadata as a JSON document. | -| `pdf` | [Cloud API Users Guide - `pdf`](./cloud-api-pdf) | [`pdf`](./client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | -| `pdf-info` | [Cloud API Users Guide - `pdf-Info`](./cloud-api-pdf-info) | [`pdf-info`](./client-api-pdf-info) | Returns PDF metadata as a JSON document. | -| `pdf-text` | [Cloud API Users Guide - `pdf-text`](./cloud-api-pdf-text) | [`pdf-text`](./client-api-pdf-text) | Returns the text from a PDF as a JSON document. | -| `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](./cloud-api-pdf-xmp) | [`pdf-xmp`](./client-api-pdf-xmp) | Returns XMP metadata from a PDF. | +| Endpoint | REST Endpoint | REST Endpoint Client Library | Description | +| ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-dlex-layout) | [`dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | +| `image-info` | [Cloud API Users Guide - `image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-image-info) | [`image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-image-info) | Returns image metadata as a JSON document. | +| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | [`pdf`](./client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | +| `pdf-info` | [Cloud API Users Guide - `pdf-Info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-info) | [`pdf-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-info) | Returns PDF metadata as a JSON document. | +| `pdf-text` | [Cloud API Users Guide - `pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-text) | [`pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-text) | Returns the text from a PDF as a JSON document. | +| `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-xmp) | [`pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-xmp) | Returns XMP metadata from a PDF. | ## REST Client From 0ec6ed04c3f67c251b0361e7e522860b303a01b2 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Fri, 29 Jul 2022 14:07:59 -0400 Subject: [PATCH 5/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index db57dbd..f5f6bfd 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ npm i @dynamicpdf/api | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-dlex-layout) | [`dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | | `image-info` | [Cloud API Users Guide - `image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-image-info) | [`image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-image-info) | Returns image metadata as a JSON document. | -| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | [`pdf`](./client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | +| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | [`pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | | `pdf-info` | [Cloud API Users Guide - `pdf-Info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-info) | [`pdf-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-info) | Returns PDF metadata as a JSON document. | | `pdf-text` | [Cloud API Users Guide - `pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-text) | [`pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-text) | Returns the text from a PDF as a JSON document. | | `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-xmp) | [`pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-xmp) | Returns XMP metadata from a PDF. | From 7884185144b0143730abb6053ecbf126450fc124 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Fri, 29 Jul 2022 14:09:29 -0400 Subject: [PATCH 6/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f5f6bfd..3be9eb7 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ npm i @dynamicpdf/api | ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | | `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-dlex-layout) | [`dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | | `image-info` | [Cloud API Users Guide - `image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-image-info) | [`image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-image-info) | Returns image metadata as a JSON document. | -| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | [`pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | +| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf) | [`pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | | `pdf-info` | [Cloud API Users Guide - `pdf-Info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-info) | [`pdf-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-info) | Returns PDF metadata as a JSON document. | | `pdf-text` | [Cloud API Users Guide - `pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-text) | [`pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-text) | Returns the text from a PDF as a JSON document. | | `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-xmp) | [`pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-xmp) | Returns XMP metadata from a PDF. | From c7cbf6c0b7b20f6feb5273560a54a2349f398bb6 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Fri, 29 Jul 2022 14:39:29 -0400 Subject: [PATCH 7/8] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 3be9eb7..89478de 100644 --- a/README.md +++ b/README.md @@ -34,17 +34,17 @@ npm i @dynamicpdf/api The following table lists the tutorial project or file name. -| Tutorial Title | Project/File/Class | Tutorial Location | -| -------------------------------------------------- | ----------------------- | ------------------------------------------------------------ | -| Merging PDFs | MergePdfs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdfs | -| Completing an AcroForm | `CompletingAcroForm` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/form-completion | -| Creating a PDF Using a DLEX and the `pdf` Endpoint | `CreatingPdfDlex` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-pdf-endpoint | -| Adding Bookmarks to a PDF | `AddBookmarks` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/bookmarks | -| Creating a PDF Using the `dlex-layout` Endpoint | `CreatingPdfDlexLayout` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-layout | -| Extracting Image Metadata | `GetImageInfo` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/image-info | -| Extract PDF Metadata | `GetPdfInfo` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-info | -| Extracting PDF's Text | `ExtractingText` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-text | -| Extract XMP Metadata | `GetXmpMetaData` | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-xmp | +| Tutorial Title | Tutorial Location | +| -------------------------------------------------- | ------------------------------------------------------------ | +| Merging PDFs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdf | +| Completing an AcroForm | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/form-completion | +| Creating a PDF Using a DLEX and the `pdf` Endpoint | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-pdf-endpoint | +| Adding Bookmarks to a PDF | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/bookmarks | +| Creating a PDF Using the `dlex-layout` Endpoint | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-layout | +| Extracting Image Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/image-info | +| Extract PDF Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-info | +| Extracting PDF's Text | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-text | +| Extract XMP Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-xmp | # Support From 2c8a02c9e7f8df51a6801447fc199506b8bbdb69 Mon Sep 17 00:00:00 2001 From: "James A. Brannan" Date: Fri, 29 Jul 2022 14:42:31 -0400 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 89478de..a44e363 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ The following table lists the tutorial project or file name. | Tutorial Title | Tutorial Location | | -------------------------------------------------- | ------------------------------------------------------------ | -| Merging PDFs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdf | +| Merging PDFs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdfs | | Completing an AcroForm | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/form-completion | | Creating a PDF Using a DLEX and the `pdf` Endpoint | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-pdf-endpoint | | Adding Bookmarks to a PDF | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/bookmarks |