From 9cbf0e79b9fd7d13f25de54bad3f00a752a39652 Mon Sep 17 00:00:00 2001 From: m0ar Date: Thu, 22 Feb 2024 10:18:30 +0100 Subject: [PATCH] Add npm cache to nodelib doc deployment workflow, remove checked-in docs, link docs in readme --- .github/workflows/nodes-lib-docs.yml | 5 +- nodes-lib/.gitignore | 1 + nodes-lib/README.md | 4 +- nodes-lib/docs/.nojekyll | 1 - nodes-lib/docs/assets/highlight.css | 50 - nodes-lib/docs/assets/main.js | 59 - nodes-lib/docs/assets/navigation.js | 1 - nodes-lib/docs/assets/search.js | 1 - nodes-lib/docs/assets/style.css | 1414 ----------------- .../docs/functions/addCodeComponent.html | 2 - nodes-lib/docs/functions/addContributor.html | 2 - .../docs/functions/addExternalUnixFsTree.html | 4 - .../docs/functions/addLinkComponent.html | 2 - nodes-lib/docs/functions/addPdfComponent.html | 3 - nodes-lib/docs/functions/addRawComponent.html | 5 - nodes-lib/docs/functions/changeManifest.html | 6 - nodes-lib/docs/functions/createDraftNode.html | 4 - nodes-lib/docs/functions/createNewFolder.html | 2 - nodes-lib/docs/functions/deleteComponent.html | 2 - nodes-lib/docs/functions/deleteData.html | 3 - nodes-lib/docs/functions/deleteDraftNode.html | 1 - nodes-lib/docs/functions/getDpidHistory.html | 2 - nodes-lib/docs/functions/getDraftNode.html | 2 - nodes-lib/docs/functions/listNodes.html | 2 - nodes-lib/docs/functions/moveData.html | 3 - .../docs/functions/prePublishDraftNode.html | 5 - .../docs/functions/publishDraftNode.html | 4 - .../docs/functions/removeContributor.html | 2 - .../docs/functions/retrieveDraftFileTree.html | 3 - nodes-lib/docs/functions/updateComponent.html | 1 - .../docs/functions/updateCoverImage.html | 2 - .../docs/functions/updateDescription.html | 2 - nodes-lib/docs/functions/updateLicense.html | 2 - .../docs/functions/updateResearchFields.html | 2 - nodes-lib/docs/functions/updateTitle.html | 2 - nodes-lib/docs/functions/uploadFiles.html | 4 - .../functions/uploadGithubRepoFromUrl.html | 3 - .../docs/functions/uploadPdfFromUrl.html | 3 - nodes-lib/docs/index.html | 74 - nodes-lib/docs/modules.html | 58 - .../docs/types/AddCodeComponentParams.html | 8 - .../docs/types/AddExternalTreeParams.html | 7 - .../docs/types/AddLinkComponentParams.html | 6 - .../docs/types/AddPdfComponentParams.html | 8 - .../docs/types/ChangeManifestParams.html | 4 - nodes-lib/docs/types/ComponentParam.html | 1 - nodes-lib/docs/types/CreateDraftParams.html | 6 - nodes-lib/docs/types/CreateDraftResponse.html | 3 - nodes-lib/docs/types/CreateFolderParams.html | 5 - .../docs/types/CreateFolderResponse.html | 6 - nodes-lib/docs/types/DeleteDataParams.html | 4 - nodes-lib/docs/types/DeleteDataResponse.html | 4 - nodes-lib/docs/types/ExternalUrl.html | 5 - nodes-lib/docs/types/IndexedNode.html | 7 - nodes-lib/docs/types/IndexedNodeVersion.html | 5 - nodes-lib/docs/types/ListedNode.html | 2 - .../docs/types/ManifestDocumentResponse.html | 4 - nodes-lib/docs/types/MoveDataParams.html | 5 - nodes-lib/docs/types/MoveDataResponse.html | 2 - nodes-lib/docs/types/NodeResponse.html | 5 - nodes-lib/docs/types/PrepublishResponse.html | 3 - nodes-lib/docs/types/PublishResponse.html | 5 - nodes-lib/docs/types/RetrieveResponse.html | 5 - .../docs/types/UpdateComponentParams.html | 4 - nodes-lib/docs/types/UploadFilesResponse.html | 6 - .../types/UploadGithubRepoFromUrlParams.html | 6 - nodes-lib/docs/types/UploadParams.html | 6 - .../docs/types/UploadPdfFromUrlParams.html | 6 - 68 files changed, 8 insertions(+), 1878 deletions(-) delete mode 100644 nodes-lib/docs/.nojekyll delete mode 100644 nodes-lib/docs/assets/highlight.css delete mode 100644 nodes-lib/docs/assets/main.js delete mode 100644 nodes-lib/docs/assets/navigation.js delete mode 100644 nodes-lib/docs/assets/search.js delete mode 100644 nodes-lib/docs/assets/style.css delete mode 100644 nodes-lib/docs/functions/addCodeComponent.html delete mode 100644 nodes-lib/docs/functions/addContributor.html delete mode 100644 nodes-lib/docs/functions/addExternalUnixFsTree.html delete mode 100644 nodes-lib/docs/functions/addLinkComponent.html delete mode 100644 nodes-lib/docs/functions/addPdfComponent.html delete mode 100644 nodes-lib/docs/functions/addRawComponent.html delete mode 100644 nodes-lib/docs/functions/changeManifest.html delete mode 100644 nodes-lib/docs/functions/createDraftNode.html delete mode 100644 nodes-lib/docs/functions/createNewFolder.html delete mode 100644 nodes-lib/docs/functions/deleteComponent.html delete mode 100644 nodes-lib/docs/functions/deleteData.html delete mode 100644 nodes-lib/docs/functions/deleteDraftNode.html delete mode 100644 nodes-lib/docs/functions/getDpidHistory.html delete mode 100644 nodes-lib/docs/functions/getDraftNode.html delete mode 100644 nodes-lib/docs/functions/listNodes.html delete mode 100644 nodes-lib/docs/functions/moveData.html delete mode 100644 nodes-lib/docs/functions/prePublishDraftNode.html delete mode 100644 nodes-lib/docs/functions/publishDraftNode.html delete mode 100644 nodes-lib/docs/functions/removeContributor.html delete mode 100644 nodes-lib/docs/functions/retrieveDraftFileTree.html delete mode 100644 nodes-lib/docs/functions/updateComponent.html delete mode 100644 nodes-lib/docs/functions/updateCoverImage.html delete mode 100644 nodes-lib/docs/functions/updateDescription.html delete mode 100644 nodes-lib/docs/functions/updateLicense.html delete mode 100644 nodes-lib/docs/functions/updateResearchFields.html delete mode 100644 nodes-lib/docs/functions/updateTitle.html delete mode 100644 nodes-lib/docs/functions/uploadFiles.html delete mode 100644 nodes-lib/docs/functions/uploadGithubRepoFromUrl.html delete mode 100644 nodes-lib/docs/functions/uploadPdfFromUrl.html delete mode 100644 nodes-lib/docs/index.html delete mode 100644 nodes-lib/docs/modules.html delete mode 100644 nodes-lib/docs/types/AddCodeComponentParams.html delete mode 100644 nodes-lib/docs/types/AddExternalTreeParams.html delete mode 100644 nodes-lib/docs/types/AddLinkComponentParams.html delete mode 100644 nodes-lib/docs/types/AddPdfComponentParams.html delete mode 100644 nodes-lib/docs/types/ChangeManifestParams.html delete mode 100644 nodes-lib/docs/types/ComponentParam.html delete mode 100644 nodes-lib/docs/types/CreateDraftParams.html delete mode 100644 nodes-lib/docs/types/CreateDraftResponse.html delete mode 100644 nodes-lib/docs/types/CreateFolderParams.html delete mode 100644 nodes-lib/docs/types/CreateFolderResponse.html delete mode 100644 nodes-lib/docs/types/DeleteDataParams.html delete mode 100644 nodes-lib/docs/types/DeleteDataResponse.html delete mode 100644 nodes-lib/docs/types/ExternalUrl.html delete mode 100644 nodes-lib/docs/types/IndexedNode.html delete mode 100644 nodes-lib/docs/types/IndexedNodeVersion.html delete mode 100644 nodes-lib/docs/types/ListedNode.html delete mode 100644 nodes-lib/docs/types/ManifestDocumentResponse.html delete mode 100644 nodes-lib/docs/types/MoveDataParams.html delete mode 100644 nodes-lib/docs/types/MoveDataResponse.html delete mode 100644 nodes-lib/docs/types/NodeResponse.html delete mode 100644 nodes-lib/docs/types/PrepublishResponse.html delete mode 100644 nodes-lib/docs/types/PublishResponse.html delete mode 100644 nodes-lib/docs/types/RetrieveResponse.html delete mode 100644 nodes-lib/docs/types/UpdateComponentParams.html delete mode 100644 nodes-lib/docs/types/UploadFilesResponse.html delete mode 100644 nodes-lib/docs/types/UploadGithubRepoFromUrlParams.html delete mode 100644 nodes-lib/docs/types/UploadParams.html delete mode 100644 nodes-lib/docs/types/UploadPdfFromUrlParams.html diff --git a/.github/workflows/nodes-lib-docs.yml b/.github/workflows/nodes-lib-docs.yml index 82122e3db..18f8effaf 100644 --- a/.github/workflows/nodes-lib-docs.yml +++ b/.github/workflows/nodes-lib-docs.yml @@ -1,4 +1,3 @@ -name: Generate nodes-lib docs and deploy to github pages on: push: branches: @@ -23,6 +22,10 @@ jobs: uses: actions/configure-pages@v3 - uses: actions/setup-node@v3 + with: + node-version-file: .nvmrc + cache: npm + cache-dependency-path: nodes-lib/package-lock.json - name: Generate docs run: | diff --git a/nodes-lib/.gitignore b/nodes-lib/.gitignore index bc5c2b24a..a33437f6f 100644 --- a/nodes-lib/.gitignore +++ b/nodes-lib/.gitignore @@ -2,3 +2,4 @@ node_modules demo.ts dist .env +docs diff --git a/nodes-lib/README.md b/nodes-lib/README.md index 72eaec5bf..cada3bcf8 100644 --- a/nodes-lib/README.md +++ b/nodes-lib/README.md @@ -3,6 +3,8 @@ This package allows programmatic interaction with the backend of [DeSci Nodes](h > **Note** > If you are just eager to get started, do heed the instructions under the Configuration section first. +> API docs are available at [desci-labs.github.io/nodes](https://desci-labs.github.io/nodes). +> There is a starter project for building an integration project available [here](https://github.com/desci-labs/nodes-integration-template). ## Core concepts Some terms are regularly referred to in the code documentation. When programmatically creating nodes, it's important to understand what these things are for the end results to make sense. The corresponding types for these data structures are available in [desci-models](https://github.com/desci-labs/nodes/blob/develop/desci-models/src/ResearchObject.ts). @@ -87,7 +89,7 @@ Publishing to the dPID registry and/or Codex requires a private key. Publishing ### Documentation This section outlines the major functionality the library provides. It's not a complete rundown of all capabilities, but should be enough to get some inutition for the workflow. -More detailed docs generated from the code is available in [docs](./docs/index.html)! +More detailed docs generated from the code is available at the [doc site](https://desci-labs.github.io/nodes)! #### Node operations - `createDraftNode`: initializes a new, empty, private node. diff --git a/nodes-lib/docs/.nojekyll b/nodes-lib/docs/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/nodes-lib/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/nodes-lib/docs/assets/highlight.css b/nodes-lib/docs/assets/highlight.css deleted file mode 100644 index 84915b514..000000000 --- a/nodes-lib/docs/assets/highlight.css +++ /dev/null @@ -1,50 +0,0 @@ -:root { - --light-hl-0: #000000; - --dark-hl-0: #D4D4D4; - --light-hl-1: #0451A5; - --dark-hl-1: #9CDCFE; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #0000FF; - --dark-hl-3: #569CD6; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --code-background: var(--dark-code-background); -} } - -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --code-background: var(--light-code-background); -} - -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -pre, code { background: var(--code-background); } diff --git a/nodes-lib/docs/assets/main.js b/nodes-lib/docs/assets/main.js deleted file mode 100644 index 3092fea0e..000000000 --- a/nodes-lib/docs/assets/main.js +++ /dev/null @@ -1,59 +0,0 @@ -"use strict"; -"use strict";(()=>{var Ie=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ie(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",H="mouseup",J={x:0,y:0},fe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",pe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.updateIndexHeadingVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.updateIndexHeadingVisibility()}updateIndexHeadingVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); -/*! Bundled license information: - -lunr/lunr.js: - (** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - *) - (*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - *) - (*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - *) - (*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - *) -*/ diff --git a/nodes-lib/docs/assets/navigation.js b/nodes-lib/docs/assets/navigation.js deleted file mode 100644 index 33c0dc4ef..000000000 --- a/nodes-lib/docs/assets/navigation.js +++ /dev/null @@ -1 +0,0 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA5XWTW/bMAwG4P/ic7FuxT6w3oak2QpkRRC0uww7KBYTC7UlQ5LTFMP+++Q0sS1ZIp0z3zyhDUvk77+ZhYPNbrNvnM8Uh5mqaiVB2hXTrDLZVVYzW7i6fa3BXMdT7wpblS76LCTPbm/ef/3y4dPNv6uhfXewoCUrHzVAkh6HJshLIZ/priOpCfaKb2l6HKLkWcHkDn4yKbZgEnAsQ7peGyPRq5KWBmZhrtk21WAYuEBcg3GtGEDMc2SaulAlB401OkxcYuKt+hnKnUMJ7vGYZfFOw/p0L9XlOEGZ5zP4pMsQG5Qo5V5yOAB/cHdFqAxKFyi/QBuhJIKdEpS5FMbGG+srlHE+lXOVN5U7UKm3n8qRvtojX4lfnWolewzqlNe+n5Q1rFHOSkPdbEphipQ2TpAmAV6mrcFqAfvk04Z1ynuqubsxiHkSDdFyqRhfiBJMqtlIZJr6Xdii2ayhVgutKnf0U30j4Wn/hMEXOXw7odUwRdks2Hx6ddvI3Lqbx1yHGd/8/DHkpPuANo1VOol1CZzqbmYpDgvTrk8JcRzEYW9tSpheBueGq1JCG0ZwbM1eKGwYQbDc27Vilp/AqH6D8WfMwPIjJPYAL29rRhrrIgjGj6sA+saCCIm1cyPttFWawN5UEEGwHdh5LfgPN8KVfo1ZfoKgsKaGdYRxk+YYMTGjKyJAdRrMsd+fa8jPaw2neYc+TSSGoVPE6ZyG9kGIe3AUQsG3kXz883bYpa7CaBCBG38sx8ggMgHbg76v2C7aYJghuTmYXIvaekty6A1CJLgUOXiLRIidAiTk9g1gOi8WAkoePQ6xHMk+Clsi3R3LKNItRHGkK5PIaOtJg6Moifd7SlrtMyPuz39sZ6gG4hEAAA==" \ No newline at end of file diff --git a/nodes-lib/docs/assets/search.js b/nodes-lib/docs/assets/search.js deleted file mode 100644 index 5f7d0cbc8..000000000 --- a/nodes-lib/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7VdWa/bRrL+L7qvZxQ2d/ptYI/vNZAJDE+SF8MIFInyEawjCVrsDAz/98tukmJVsaoXUnnJsaLa2F9VdfHjou+L8/HbZfHq4/fFl91hs3gVR1WhsvhpcVi91ItXi9fnenWt35xX2+v71Xn1clk8LW7nffPN9b+n+vLT6Pvl8/Vl3wit96vLpW5MLxY/nnrreZYl+d32H39oG14G/+cuC+w+LU6rc324smEOTlUUp3ef1911H+Ry2Wt4Ol52kQr+97vDF7817P33GpP9z130NoLO7j9UcCjdEQgLctpsZwSzbNWnBOQA6qW+rjar62pOcMDG3xDhpt6ubvvrz7t1fbiEITpSfUxyn+tLvTqvn9/u6v0mLMtHqpMjsnSwD/XldLSuVS/xwC6GTAb0sXuwwmIfv4T5XBoFb7cOqJ9Xl+dA/53KoyK4nXeBAbQaj/J/OG4CUV92Ko+K4Gt9vuyOh8AgBq1HxbE5rm8vjfK7TWAoSHFGNPkQy3qQ/wUCtL0d1tfmsC8/EQlrpdNe8vPucq03v4yRH76Y2zmIJVfDABFJdXLbUVx4H8tO0uXIkQ2+3h7hq8Vy88+rn0soPtPz7bQJ8QzFZ3o+fjvU51GpCX4H4ZleublZ8GkfmL09vqwOu219uf523vv5xQpzs/jy/vbnfnd5rn3TGSnMzWvfIlo/ooq0yOtjsy/4+YTic1f5sKn/8lzfTjTcYw7Pvi6m6Q+z6bAv3L+zd3A4f+9r+1ZDJIK2Gq0gzKvwq7nbzciWa8NBcfluAZIX2yaAdKZtA6Jb90YQ4F3aCkTv7s0gwDvXmEXP9tYcsuL+ENtaVIDHy7VZM1+fvfBsr7vL2yZTbufRLiBnNNSY7V/eBMUAfLbBCRG8GXMhzhDe2LiPgBjO9Wm/W690U327Wl+PdKMSA+EUZ0fDD2BiDK4RLKTTjEd5ucnYhvkAn+0eFtDdoMID6u9Na86//AaFx+W+dILrrgD3GW5I163Pq5fd+j/XZvt68e6/RGlKFGDq+VxfbSMP/Dpo3nnf1Go7QAtTz1hg7uwjWHRNQEykvhSd3aONoWM0vaaSf3eJ+HrUORyxsPp/T2yzAntcVDyd5ojGxaYFR2GrcUcsfpXuExGo99O57k5sbWXPSIVVv730H1z3U4p+asVPLPcH1/qDCn1KJr97Q68E2aJBShOjgNnrkbpz8rYdNvScy14dp1/PzVzWnit1RzH6T5c2f/YJc6Rpz5XT6kovJ1l9d/JTfcswCh1oLPA4KIP6EBOpY3gN8rt8cW2rjL7fED3uSp6h2DqSTzRjyg6eyo7YuubLoBbw7+NXuQHgL+fmDGPNlS8kOv/Sl33ZC5/oOU6l95v348q3uB4UHuD9UH8L8z4oTPMupY7QdOjXj0qfoIYzijGs3dh8upvNSHtqq/EKw9Zo3JGANvPSCTNNpv8qqMV8qK/nXf1Vuh5Av56bJ6w9V56MYrTwuDfaJm0el3cNP8cuvvxchxzvspN/iO/NmMK2+t7YWGy37xwyqK2wmXLf7vb1r3AZhvRk5YJytb1h423TqOuz5Y5RKPCYm61GFv3utUKR+m+Pdp/2LZLRtefN/thy2Mxu5YiDaD4onq0R/UV/CIoG6U2PxZZy1lv8sMgj027CTX4k3rBt1eXbvbWyFqZur97h2LbYCRExzdwZirWhT4iBaerOGKyN3S+G0T1vv9TfWh2mrROJoIb+22l/XG3YVg6/mltNI1uuKkJx+TduyY+9ZSMtR06uzp/rK9OqRc9IY7Z/3fL3euvWBp2IwY0CaU2Jg08dbfUi9GVG4jGJNDbpl0842LCm7PDs7smcgakt2TcYW0cOj4dpyK5ArP04PAKmHbsisHZjrwhAM74N8kwjBt9OacKb7dvz8eW3897WjonQgxozZ9WzRdOog5u1xbdX26b69gyq/7rW58NqP77nxiMcrPzAqFzbii0o/w0mLKb18aUpiMbAf25/TsqcJWNhXny0cP4lggm+mVsi1JSrLmBQ4tMtrniHp1rkTIM6wRdgJIfWay9Wj6M2OeAp9spBZELD/N/d9fn254f6dHT3TUH2Me3TZtyvi0qHEtpMPSLx6amSmXmt1Sc4/w47LUZHo/UJ0bvfTovQq+36xBnYfb2jHdX5SFMs95FkUNX/c7PpG5AmLtlqZ2XmVrls1FXdfMj+Ve30bK9mXt2viptTB//FpeXbKT8uKrFu3TF51OuUiO7l9euEhFlS7b8hLr5/BITm6hue0YF+sRo0fjvs/np7ES5UsHJBveKdfqCofWbod/bOv7HA3C4hWHS1CCZS78cy7C6tD2cwqva8CnX+SN/X3ehihMN7pzHdvyWh5EgemEKhuTMFtgl4OZNERd7+jOhcj+YBDE+Xvexcn+d63aiMWTnJL5Sf67u7JZluzZJrID7BM3ky4LTb/N/ucj2e/8v0bCwQdlX5eXX4XPf3qPLXlRmR2Zf4JJvOS3xcvAFXlx1+HdeXOW17zqxaiELDGNTmRDK6LYo8PCPdHiWIzb5NymbXebuUFLtEV0uPFvlE4fMCDdGOg0bvxOdE9YCY4FVOlEtMe8ECYe2lH2hNitIqQF/aswsNsh9W3+66/AgLJQLpLX3RAkc2prUYmfl0lmTUTWNxIbtOUULdL6FmQCC+p0zvmDcWBAT1zvoWA8/IEL2CNFhaBUmE0ik/7w5f7GnGCz2AUJGsejAqXNTSTcDju5jcvpcH2z1Mgr49w8aEv0cYNu5/UhQXiRFwRXJxMwETormuzuNH732iuSvOiwb3c6TCN3QkElpr7zdbZ6mNZR5QaYJRj0JjQg6qM7tnZ5kx6u7LXL8e9fX34FiQ6uMiGlM27lBsrM2UGMSqd8ThUfThsUg174rFXfI+seCKhxp8wUOJ0Hp/bV6k5Ch4RugBFS9Z9Sh5Luqgmnf4dhY9px98cdsjDut17klxsLXuCsNR7OFR7JvTpNvq8wRkgOYD4xG7jyscj/YzIRqp/zijcTcgr2hwB0IqfAtCIr6np+3DjjbLRMLXcHu+8St6KxU9GzHfhhl8U1/W593pCi/TULNAJsw4fYUyNdx9H2b0A/8yZGobiwWwC6+Ph+t59+cNvg6J5MVdwNfsudbPp9ktj2TClsW8OfDdC+w/45PVXoQz/empe23gq+/3V3a8WsTLZFk1ktt2tV997Def5tTbcFGfuu9+r/V7oLREK/JTtHj6GD2l1TIqik+fnj72GuYL8z+MmGo+qSdVLfMkQWIKicXNp/gpjZZ5lCKxGIklzaeEc5ogsVRymiKxrPmUctYyJJY3nzJOLEdiRfMp58QKJFY2nwpOrERiDSgfS06swssbietLcNDrXXErrDASSq+4YpFVGAylF10pVhLjoQwgMSuJIVF66VUDcZOWeYUlMSpKr75KWUkMjNIAKBZBhbFRGgPFgqgwPKoS1x0DFBuAiqe4kVQlTm2MUGxKpXxKymVUKSxJisVAVHGHHmOIYo1DHLGSGKJY4xArVhJDFGdirWKEYg1DHLMmMUKxhiFmCzvGCMUahmbsSPJlVGZYEiMUaxxiFvUYQ5RoHGIW9QRDlGgcYrZ6EwxRYhoaW8AJaWkGooqVxBAlYltLMEJJJmZSgiFKcjGTEgxRUoiZlGCIklLKjwQjlFQilglGKNUwJGxPSjFCqYYhYXtSihFKYzE7U4xQanYdtnulZN/ROCRsHqcYojQTyy3FEKW52EBSDFGqcUjYDS3FEKUaiIStjRRjlGogErY2UoxRZjAquCPKMEaZwYitjQxjlGkgErY2MoxRlki1kWGIslTaBzMyHJjpgE34DCOUaRhSNucyjFBWiLtbhhHKSnk1MUKZhiFlszPDCOUahpTNzhwjlItTW44BymNpNXOMT56Iq5ljgHINQ8pmcY4Ryg1C/GRGJjiDEJvFOUYoL8QjxwDlpViWOQYoNwAV7CJhgAoDEFsYBQaoEAEqMECFhiGtuK2gwAgVGoYsYiUxQoWGIWPzvcAIFRqGjM3NAiNU5OIBkSm7ENe9wAgVGoaMTfcCI1RoGDI25QqMUKlhyNiUKzFCpYhQiREqZYRKjFApI1RihEqDEJvvJUaoNAjx5yMYoVJEqMQIlRqGjM3ikpwKGYTY9lFihEoNQx6xkhihSsOQs8lZYYQqjUPOJmeFIapi6dArjFCViMlZYYQqDUPOJmeFEao0DDmbnBVGqNI45GxyVhiiSuxyFUaoKsXkrMj5aiUmZ0VPWSMR9vY7KKtE4NvvoKwGI+fP3iJy6hppOHI279vvoKw4d7dfQdFMTID2Oyhr4GKn9PY7KGvIBXYQar+DsoZh4E/gI3IWG8mnsRFBzfAJfCqoEdegxGRQlG4wpIKQDZRwMLSCkA2UcjDEQsGzE5R0MNRCwfMTlHZQYh9UlHdQ8l6lKPNg+IUi4Q+NoGYoBiFzCP2gDMlQpKxdQkAoQzMIMcSUJRJ7oiIchDJMQ5GxTA1hIZThGvhhSREeQhm6oeDrnVARyhAOBV/vhIxQsdgdFWEjVCxPgYrwEcqwDtLqEtQM7yAgTDgJZZgHAWHCSijDPRTs3qwSyu4Z2PieQ5gJJVMTinATKrG0SMJOKMNBlHwrI/yEMiyEtGQENkNElAJzSWAzVIS0vAQ2Q0aUAs9JYDN0RMlOAIpQFSqVi41wFcowEjypolLKyhrU+CUjfIUyrETJjiGKMBbK8BIlT7gSzkKlcrER0kIZakIKl6BmyImS7w2EuFCGnij53kCoC2UIipIvIEJeKENRlHwBEfpCGZai4jOdMBiqpTD47M0onZ6Jy0tYDJXJRJMiPIYybEXFJzphMpThKyo+0QmXoTJ5HiFkhjKUhcT/E9QMa1HxyUsYDdVSGnzyElJDGeqi4rOM0BrKkBcVn2WE2FCGvqj4LMvpZRB5HiHchjIURsUnJKE3VMtvRHxGEoZDGR6jmcd5YQKcoTKagZy/HkOQk4kORZgOVbQXrvgNlpAdqrDMJITuUIbUaEZ93jCBzvAazazPCxPsWtYj4hOooFexTKeM+Awi3IcyDIewbgS8orKtGwGvbMHjU5NQIMowHcJeRFgQVcaWRSZEiDJ0h7TIhAtRZQsfn/aEDlGG9FDC5U/CiCiZElGEE1FlYVlkQosoQ34IQzAhRlQpX0RRhBpRhgBRwhVbwo4ow4FIgBCCRLUMiQAIIUlUy5IIl4MJT6IMG6IUv30QqkRVLXp8oydsiTKciBKuCxPCRLWMiXBpmJAmylAjzRkeL0wvJJvyU3xFEeokjloE2VyOCXcSG35ExWwuxx15Yu4K+Vqfr/WmfcZC39/R38z4ffFHd8uI6u9G+b5QzX9+PC3S9k9z5t/+rdq/Sff/m5nF/M078WZ7MX+L7nPT3Mzfsvtcdp+bXGn/Fr39u6POgz7Lbv8Rx/0/euHeu56Ku3/0XzXTTveP3k7e2+lj0p2x/UcbzY/hLhj9SS/f/cG9YWmqGKxNVkiKm836uKnXw41jYHEVNFElniZO3Z2v0FAEDJWZzRC4VQkaKGEklWygfx2FfgvdOJDmrHEwk1gOqDdzO+z+2l7aV9oNZkq4Lmkkm9nvDl/4pY1yYKIQYSUmmKWNYCyFJZbTZiuEAhelTP0scJEUMBJLwp1X39hIKmgglwLpflHGvG5k0E3TQdeleul+UGnQToDnrOscWSlZMc8lDi9/BAeQwQOIvfTHC1nBppaJx6JvIx6UYnD8cdcukr6jpEnfP/qOUkolxAMDMySXkL2rtlooNWD95+LCouRCAcBqyaW6vevfbyQGlQ/WR/OLXV/u1yNxrgc1WEKUEvGQ2h+mXeGKA8vZ7xWJ1AI6C/r97QfzJgpgB6abiMqgP041AIvUOYD++f7cNliGwYK4hMZC+67wcQg56F+V8jDBRZGDlajsK3mov2271yoDfZhfkVS47XtFgRZYvrKvtahPKSWl6aberm77676/SRkYHOxJcLZ3cQvbdQI3SalxdL/niVMyAeWR2n1vzA9hDKoZKITC6XQ1zoAUHHYugTcY4PBPQRqKe2BngqukGOgnIvz3x+BBY4JtJZfSt9fELVsh3X74k6LvJxK68ZWwtYpd5D7P6AdMQVeEGaP6KTPuUziWSrqtIKMJ0xccUCUNeZ/r6+a02zz3bxUBawmPJJOqR+tzECYAwkwC4nl1ecYbE9wVBCWCGvDTL1TSz/Dpfc6XNoT2HTgAPth5Umm9RztqDNQSKWV27Yte6EqVcNtIpYwByvffxAQ2YOKk0nLvLpv+x3sBUMC9vEyX7f1Xt4EqaDUWp90vAGLdGEQcSx1ueCAKtlW401fSYus5HRUm8CflchPldYyPgikhLZBW1YrIZQzG2ERaH/Nm+O1uX5/aN8OD+oVjXiSuUfcTJO3jdEAbHLC4+XBTcwrcFt04VPan231PUtK69xbJPJyByi668bfs/lb3M3ZpjXqjdK9LwLCSSqjeldmunwB0xXqnJrg9r4IlKJ6s9JZI44/BgcTd3pNKDfClvq5Guz7YsyW149fxsACOXjzV7BXHo0IGwi6kHaZX5xYtA3GXUkrRfU3To2DQ7imcok+jUiqVZtakVZKBPbKQ4B91BMQ3WJTW+kkrhDM4XnE315rcYsWgMEWyRP/oLUhKOE+0y5N1e6J4PtzMEqNVAgteSKndvdsNbEqQP8gkdI0aOXkGHT7uwk2l9KKxpsBr3qdEb0XT4rKZ63FrXj8AUw0SXWKGnjZbFAIYfSSN+69Es9NTCjIsk/JksMFlSwKwzySsrTHAniIehxxACpJGHKPbF/ORzaKEiy4Oj+2DkiJDCU/qI9n9qTnvM/vndrUmNhJwAKlU5ufu+dLuwUg4zIPWJiq3Pwdn1l/nHmU2c1AJ4qjTW2EbLIxCAvH+aDVMfERm9AN1v2WrSsoo/WuCOA/Bzi9ys/1vEILAQQ6IDZ0hlvSVKBD4ve77XULkNNqXFI+mKJiKUX9W2F/FUMmduZJCbF+DCnIbhic2tWv7fDdoiSCbW5dxh4nIddFcykBFlP0cF/UHIJ5utc8MC1Q1HMVzqU8RCwzDChdZbDW9mSbRdy/0pCCOYLlLGHe/xY65FqTa5bcIZ2cBPi0Pmw4sGpH46mywszdY0MxTnzTPFBxOfzFLpGhbUwz1pdBZT2VfDrkH6oubwIyUqq2ZUdIrRMmIFEb7Zvtt+5NAoP/C5BTHNKDM9c8CMhKRHL828tm8W7/ZUo7b8/GFUjswx0VOSzDEXDmD6xrLmaLNMSQv1I7k5DDamy13ODA9YjsygwXmOOAorUQ75x3OC7iWog4OGJZmX+aqELVvhGYqYH9ptdNuO8i7Zlp015Cr3nrUb5uqv7rcXwpSd4pKrHKG5UGEcmdAvJI8vHcYbD7wfIAfCj89LU67U9MSDo3Ux08/fvw/Bl++lMOgAAA="; \ No newline at end of file diff --git a/nodes-lib/docs/assets/style.css b/nodes-lib/docs/assets/style.css deleted file mode 100644 index 98a437794..000000000 --- a/nodes-lib/docs/assets/style.css +++ /dev/null @@ -1,1414 +0,0 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } -} - -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} - -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} - -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} - -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} - -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} - -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} - -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} - -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} - -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} - -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} - -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} - -.uppercase { - text-transform: uppercase; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1700px; - padding: 0 2rem; -} - -/* Footer */ -.tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} - -.tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; -} - -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} - -pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} - -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} - -.tsd-theme-toggle { - padding-top: 0.75rem; -} -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; -} - -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} - -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} - -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} - -.tsd-anchor { - position: relative; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} - -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; -} - -.tsd-page-navigation ul { - padding-left: 1.75rem; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 4rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group details { - margin: 2rem 0; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} - -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -img { - max-width: 100%; -} - -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} - -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} - -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} - -.deprecated { - text-decoration: line-through !important; -} - -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} - -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-literal { - color: var(--color-ts-type-literal); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} - -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} - -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} - -*::-webkit-scrollbar { - width: 0.75rem; -} - -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} - -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} - -/* mobile */ -@media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } -} - -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } -} diff --git a/nodes-lib/docs/functions/addCodeComponent.html b/nodes-lib/docs/functions/addCodeComponent.html deleted file mode 100644 index f9fd72662..000000000 --- a/nodes-lib/docs/functions/addCodeComponent.html +++ /dev/null @@ -1,2 +0,0 @@ -addCodeComponent | @desci-labs/nodes-lib

Function addCodeComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/addContributor.html b/nodes-lib/docs/functions/addContributor.html deleted file mode 100644 index 46f49eef9..000000000 --- a/nodes-lib/docs/functions/addContributor.html +++ /dev/null @@ -1,2 +0,0 @@ -addContributor | @desci-labs/nodes-lib

Function addContributor

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/addExternalUnixFsTree.html b/nodes-lib/docs/functions/addExternalUnixFsTree.html deleted file mode 100644 index 24b451662..000000000 --- a/nodes-lib/docs/functions/addExternalUnixFsTree.html +++ /dev/null @@ -1,4 +0,0 @@ -addExternalUnixFsTree | @desci-labs/nodes-lib

Function addExternalUnixFsTree

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/addLinkComponent.html b/nodes-lib/docs/functions/addLinkComponent.html deleted file mode 100644 index 6a3c67c99..000000000 --- a/nodes-lib/docs/functions/addLinkComponent.html +++ /dev/null @@ -1,2 +0,0 @@ -addLinkComponent | @desci-labs/nodes-lib

Function addLinkComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/addPdfComponent.html b/nodes-lib/docs/functions/addPdfComponent.html deleted file mode 100644 index 02d701590..000000000 --- a/nodes-lib/docs/functions/addPdfComponent.html +++ /dev/null @@ -1,3 +0,0 @@ -addPdfComponent | @desci-labs/nodes-lib

Function addPdfComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/addRawComponent.html b/nodes-lib/docs/functions/addRawComponent.html deleted file mode 100644 index b3e54fe78..000000000 --- a/nodes-lib/docs/functions/addRawComponent.html +++ /dev/null @@ -1,5 +0,0 @@ -addRawComponent | @desci-labs/nodes-lib

Function addRawComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/changeManifest.html b/nodes-lib/docs/functions/changeManifest.html deleted file mode 100644 index 3017495ff..000000000 --- a/nodes-lib/docs/functions/changeManifest.html +++ /dev/null @@ -1,6 +0,0 @@ -changeManifest | @desci-labs/nodes-lib

Function changeManifest

  • changeManifest(uuid, actions): Promise<ManifestDocumentResponse>

  • Send a generic manifest change to the backend. Normally, one of the -special-purpose functions is easier to use.

    -

    Parameters

    • uuid: string

      ID of the node

      -
    • actions: ManifestActions[]

      series of change actions to perform

      -

    Returns Promise<ManifestDocumentResponse>

    the new state of the manifest document

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/createDraftNode.html b/nodes-lib/docs/functions/createDraftNode.html deleted file mode 100644 index 92d50dbaa..000000000 --- a/nodes-lib/docs/functions/createDraftNode.html +++ /dev/null @@ -1,4 +0,0 @@ -createDraftNode | @desci-labs/nodes-lib

Function createDraftNode

  • createDraftNode(params): Promise<CreateDraftResponse>

  • Create a new draft node, an empty base for further interaction. A draft -is the target of iterative file uploads, changes to metadata, etc and -remains private until the next call to publishDraftNode.

    -

    Parameters

    Returns Promise<CreateDraftResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/createNewFolder.html b/nodes-lib/docs/functions/createNewFolder.html deleted file mode 100644 index 70f418e14..000000000 --- a/nodes-lib/docs/functions/createNewFolder.html +++ /dev/null @@ -1,2 +0,0 @@ -createNewFolder | @desci-labs/nodes-lib

Function createNewFolder

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/deleteComponent.html b/nodes-lib/docs/functions/deleteComponent.html deleted file mode 100644 index 5560e76bc..000000000 --- a/nodes-lib/docs/functions/deleteComponent.html +++ /dev/null @@ -1,2 +0,0 @@ -deleteComponent | @desci-labs/nodes-lib

Function deleteComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/deleteData.html b/nodes-lib/docs/functions/deleteData.html deleted file mode 100644 index ae827517b..000000000 --- a/nodes-lib/docs/functions/deleteData.html +++ /dev/null @@ -1,3 +0,0 @@ -deleteData | @desci-labs/nodes-lib

Function deleteData

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/deleteDraftNode.html b/nodes-lib/docs/functions/deleteDraftNode.html deleted file mode 100644 index 386932dd0..000000000 --- a/nodes-lib/docs/functions/deleteDraftNode.html +++ /dev/null @@ -1 +0,0 @@ -deleteDraftNode | @desci-labs/nodes-lib

Function deleteDraftNode

  • deleteDraftNode(uuid): Promise<void>

  • Parameters

    • uuid: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/getDpidHistory.html b/nodes-lib/docs/functions/getDpidHistory.html deleted file mode 100644 index 343d20d71..000000000 --- a/nodes-lib/docs/functions/getDpidHistory.html +++ /dev/null @@ -1,2 +0,0 @@ -getDpidHistory | @desci-labs/nodes-lib

Function getDpidHistory

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/getDraftNode.html b/nodes-lib/docs/functions/getDraftNode.html deleted file mode 100644 index e46c89464..000000000 --- a/nodes-lib/docs/functions/getDraftNode.html +++ /dev/null @@ -1,2 +0,0 @@ -getDraftNode | @desci-labs/nodes-lib

Function getDraftNode

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/listNodes.html b/nodes-lib/docs/functions/listNodes.html deleted file mode 100644 index b742efa33..000000000 --- a/nodes-lib/docs/functions/listNodes.html +++ /dev/null @@ -1,2 +0,0 @@ -listNodes | @desci-labs/nodes-lib

Function listNodes

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/moveData.html b/nodes-lib/docs/functions/moveData.html deleted file mode 100644 index 55f859239..000000000 --- a/nodes-lib/docs/functions/moveData.html +++ /dev/null @@ -1,3 +0,0 @@ -moveData | @desci-labs/nodes-lib

Function moveData

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/prePublishDraftNode.html b/nodes-lib/docs/functions/prePublishDraftNode.html deleted file mode 100644 index 396d39afe..000000000 --- a/nodes-lib/docs/functions/prePublishDraftNode.html +++ /dev/null @@ -1,5 +0,0 @@ -prePublishDraftNode | @desci-labs/nodes-lib

Function prePublishDraftNode

  • prePublishDraftNode(uuid): Promise<PrepublishResponse>

  • Computes the draft drive DAG, and updates the data bucket CID -with the new root. Note this does not actually publish the draft, -just tells the backend to prepare for it.

    -

    Parameters

    • uuid: string

      UUID of the node to prepublish.

      -

    Returns Promise<PrepublishResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/publishDraftNode.html b/nodes-lib/docs/functions/publishDraftNode.html deleted file mode 100644 index d3ec1d5a6..000000000 --- a/nodes-lib/docs/functions/publishDraftNode.html +++ /dev/null @@ -1,4 +0,0 @@ -publishDraftNode | @desci-labs/nodes-lib

Function publishDraftNode

  • publishDraftNode(uuid): Promise<PublishResponse>

  • Publish a draft node, meaning to compile the state of the drive into an -actual IPLD DAG, make the IPFS CIDs public, and register the node on -the dPID registry and Codex.

    -

    Parameters

    • uuid: string

    Returns Promise<PublishResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/removeContributor.html b/nodes-lib/docs/functions/removeContributor.html deleted file mode 100644 index 0e4df4440..000000000 --- a/nodes-lib/docs/functions/removeContributor.html +++ /dev/null @@ -1,2 +0,0 @@ -removeContributor | @desci-labs/nodes-lib

Function removeContributor

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/retrieveDraftFileTree.html b/nodes-lib/docs/functions/retrieveDraftFileTree.html deleted file mode 100644 index 4ce071dcb..000000000 --- a/nodes-lib/docs/functions/retrieveDraftFileTree.html +++ /dev/null @@ -1,3 +0,0 @@ -retrieveDraftFileTree | @desci-labs/nodes-lib

Function retrieveDraftFileTree

  • retrieveDraftFileTree(uuid): Promise<RetrieveResponse>

  • Get the state of the drive tree of a draft node.

    -

    Note this may be different from the published version.

    -

    Parameters

    • uuid: string

    Returns Promise<RetrieveResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateComponent.html b/nodes-lib/docs/functions/updateComponent.html deleted file mode 100644 index 063a16745..000000000 --- a/nodes-lib/docs/functions/updateComponent.html +++ /dev/null @@ -1 +0,0 @@ -updateComponent | @desci-labs/nodes-lib

Function updateComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateCoverImage.html b/nodes-lib/docs/functions/updateCoverImage.html deleted file mode 100644 index a1335f127..000000000 --- a/nodes-lib/docs/functions/updateCoverImage.html +++ /dev/null @@ -1,2 +0,0 @@ -updateCoverImage | @desci-labs/nodes-lib

Function updateCoverImage

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateDescription.html b/nodes-lib/docs/functions/updateDescription.html deleted file mode 100644 index 33f905362..000000000 --- a/nodes-lib/docs/functions/updateDescription.html +++ /dev/null @@ -1,2 +0,0 @@ -updateDescription | @desci-labs/nodes-lib

Function updateDescription

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateLicense.html b/nodes-lib/docs/functions/updateLicense.html deleted file mode 100644 index af8e64841..000000000 --- a/nodes-lib/docs/functions/updateLicense.html +++ /dev/null @@ -1,2 +0,0 @@ -updateLicense | @desci-labs/nodes-lib

Function updateLicense

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateResearchFields.html b/nodes-lib/docs/functions/updateResearchFields.html deleted file mode 100644 index a37b18dc4..000000000 --- a/nodes-lib/docs/functions/updateResearchFields.html +++ /dev/null @@ -1,2 +0,0 @@ -updateResearchFields | @desci-labs/nodes-lib

Function updateResearchFields

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/updateTitle.html b/nodes-lib/docs/functions/updateTitle.html deleted file mode 100644 index 5ad534a0d..000000000 --- a/nodes-lib/docs/functions/updateTitle.html +++ /dev/null @@ -1,2 +0,0 @@ -updateTitle | @desci-labs/nodes-lib

Function updateTitle

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/uploadFiles.html b/nodes-lib/docs/functions/uploadFiles.html deleted file mode 100644 index 0b3f5ba61..000000000 --- a/nodes-lib/docs/functions/uploadFiles.html +++ /dev/null @@ -1,4 +0,0 @@ -uploadFiles | @desci-labs/nodes-lib

Function uploadFiles

  • uploadFiles(params): Promise<UploadFilesResponse>

  • Upload a set of files to the node drive.

    -

    Note that these do not become public until publishDraftNode has been -called, even if the node has previously been published.

    -

    Parameters

    Returns Promise<UploadFilesResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/uploadGithubRepoFromUrl.html b/nodes-lib/docs/functions/uploadGithubRepoFromUrl.html deleted file mode 100644 index 37000c2a1..000000000 --- a/nodes-lib/docs/functions/uploadGithubRepoFromUrl.html +++ /dev/null @@ -1,3 +0,0 @@ -uploadGithubRepoFromUrl | @desci-labs/nodes-lib

Function uploadGithubRepoFromUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/functions/uploadPdfFromUrl.html b/nodes-lib/docs/functions/uploadPdfFromUrl.html deleted file mode 100644 index 856b19bff..000000000 --- a/nodes-lib/docs/functions/uploadPdfFromUrl.html +++ /dev/null @@ -1,3 +0,0 @@ -uploadPdfFromUrl | @desci-labs/nodes-lib

Function uploadPdfFromUrl

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/index.html b/nodes-lib/docs/index.html deleted file mode 100644 index 489d5d3b7..000000000 --- a/nodes-lib/docs/index.html +++ /dev/null @@ -1,74 +0,0 @@ -@desci-labs/nodes-lib

@desci-labs/nodes-lib

Nodes integration library

This package allows programmatic interaction with the backend of DeSci Nodes, simplifying creation of research publications by abstracting away a lot of low level detail. In particular, constructing correctly formatted manifest files and handling pinning.

-
-

Note -If you are just eager to get started, do heed the instructions under the Configuration section first.

-
-

Core concepts

Some terms are regularly referred to in the code documentation. When programmatically creating nodes, it's important to understand what these things are for the end results to make sense. The corresponding types for these data structures are available in desci-models.

-

The manifest

The data structure of a research object is a JSON file which holds all information for the object, -either directly through constant fields, or indirectly through IPLD or web links.

-

Here is an example manifest file, we'll go through it piece by piece.

-
{
  "version": "desci-nodes-0.2.0",
  "components": [
    {
      "id": "root",
      "name": "root",
      "type": "data-bucket",
      "payload": {
        "cid": "bafybeicrsddlvfbbo5s3upvjbtb5flc73iupxfy2kf3rv43kkbvegbqbwq",
        "path": "root"
      }
    },
    {
      "id": "05d6cfe7-d3f8-4590-97ee-bec0a4806c3c",
      "name": "manuscript.pdf",
      "type": "pdf",
      "subtype": "manuscript",
      "payload": {
        "cid": "bafybeiamslevhsvjlnfejg7p2rzk6bncioaapwb3oauu7zqwmfpwko5ho4",
        "path": "root/manuscript.pdf",
        "externalUrl": "https://mydomain.com/papers/manuscript.pdf"
      },
      "starred": true
    },
    {
      "id": "0b6afb37-0e95-49d4-80e3-1a3724979594",
      "name": "my search engine",
      "type": "link",
      "payload": {
        "url": "http://google.com",
        "path": "root"
      },
      "starred": false
    }
  ],
  "authors": [],
  "title": "My Node",
  "defaultLicense": "CC BY",
  "researchFields": []
}
-
-

Components

In the manifest above, we see a components array. The first entry is a special one, the type data-bucket indicates that it holds the CID to the drive. The drive is an UnixFS tree that holds all of the actual data included in the research object.

-

Other components exist to attach metadata to individual files or folders inside the drive. This allows metadata to be added without changing the CID of the files and drive, and allows you to add metadata to external CID's and URL's.

-

The components are equipped with a UUID to allow moving files and updating files without the metadata mapping to break.

-

We can see two examples of other components. One is a file entry for a manuscript, which was added from an external URL, but is identified uniquely inside the node by the path and cid entires in the payload.

-

The other component (my search engine) is an external link, which is the one type of component which doesn't refer to an entry in the drive.

-

Other fields

The other top-level fields contain a human-readable title, simple metadata about authorship, relevant research fields, and license information.

-

Usage

Configuration

Copy .env.example from this repo to .env, and configure the values depending on which environment is being targeted. If installing nodes-lib through NPM, set these variables in your host project environment instead.

-

Some variables have different values depending on environment, re-set them as necessary. A detailed read of the .env.example file will be helpful. "Devcluster" refers to the docker-compose cluster defined in the root of this repository, which can be started with ./dockerDev.sh. See further instructions in the repo root docs.

-

Drafts

A node that's being modified is always in a "draft" state, meaning that the changes are not public. They only become public when the node is published, after which it's possible to view without being authenticated. When new changes are made from this point, they are not publicly available until publish is done again.

-

Manifests cannot be submitted "whole", as the state of draft manifests are maintained internally as automerge CRDT documents. Hence, one needs to send change chunks so that the lib submitted changes can be interspersed with simultaneous webapp edits. This means that your calls will more or less instantly be reflected in the webapp.

-

Authentication

Most functions ineracting with the Nodes backend require authentication, as they work on your private draft node. You can create an API key under your profile at nodes.desci.com. Set this as AUTH_TOKEN in your environment.

-

Publishing to the dPID registry and/or Codex requires a private key. Publishing is done in-library and is not sent to the Nodes backend. Set the environment variable PUBLISH_PKEY and it will be used in interaction with the dPID registry on-chain, and as your DID in the Codex/Ceramic case.

-

Documentation

This section outlines the major functionality the library provides. It's not a complete rundown of all capabilities, but should be enough to get some inutition for the workflow. -More detailed docs generated from the code is available in docs!

-

Node operations

    -
  • createDraftNode: initializes a new, empty, private node.
    • -
  • prepublishDraftNode: instructs the backend to re-compute the DAG, which is emulated to speed up operations in the drive. This is called automatically in publishNode, so in general it doesn't need to be invoked explicitly.
    • -
  • listNodes: list existing nodes for the authenticated user.
    • -
  • retrieveDraftFileTree: get the drive file tree.
    • -
  • deleteDraftNode: remove a draft node.
    • -
-

Manifest operations

Pretty self explanatory; these update the top-level metadata fields in the manifest:

-
    -
  • updateTitle
    • -
  • updateDescription
    • -
  • updateLicense
    • -
  • updateResearchFields
    • -
  • addContributor
    • -
  • removeContributor
    • -
-

File operations

These functions adds, removes, and organizes files in the drive. Everything operates on absolute drive paths; there are no relative-path operations.

-
    -
  • uploadFiles: upload one or more local files to the node drive.
    • -
  • createNewFolder: creates an empty folder in the drive, which can be used as a target for uploading/moving files.
    • -
  • moveData: move a file or directory to a new path in the drive. Note that this covers rename operations.
    • -
  • deleteData: delete a path (and its potential subtree) from the drive.
    • -
-

External import

These imports automatically create components for attaching metadata, in addition to creating the files in the drive.

-
    -
  • uploadPdfFromUrl: let the backend get a PDF from URL and add it to the drive.
    • -
  • uploadGithubRepoFromUrl: let the backend download a snapshot of the repo and add it to the drive.
    • -
  • addExternalUnixFsTree: upload the structure of an external UnixFS tree to the drive, without the actual files. They can then be resolved through regular IPFS means, but the file structure can be browsed in the node.
    • -
-

Publishing

Until a publish operation has been run, the entire content of a node is private.

-
    -
  • publishNode: publishes said node to the dPID registry on the Görli testnet, and Codex on Ceramic.
    • -
  • getDpidHistory: fetch the dPID registry history, as the backend is aware of it.
    • -
  • getManifestDocument: get the state of the node manifest.
    • -
  • addLinkComponent: create a link to an external resource.
    • -
  • addPdfComponent: create a component for adding metadata to a PDF document in the drive.
    • -
  • addCodeComponent: create a component for adding metadata to code in the drive.
    • -
  • deleteComponent: remove a component from the manifest.
    • -
  • addRawComponent: create a new component in the node.
    • -
  • changeManifest: make an arbitrary change to the manifest.
    • -
-

Application ideas

Some random ideas of cool stuff you can build with this library:

-
    -
  • A CLI tool for uploading large datasets to nodes
    • -
  • A tool which parses your ORCiD or Google Scholar profile and creates a node for each publication
    • -
  • An automatic Node manager which regularly pushes new data to a node and publishes it
    • -
  • Custom importer, allowing creating nodes from other input formats
    • -
-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/modules.html b/nodes-lib/docs/modules.html deleted file mode 100644 index 46f9b15e2..000000000 --- a/nodes-lib/docs/modules.html +++ /dev/null @@ -1,58 +0,0 @@ -@desci-labs/nodes-lib

@desci-labs/nodes-lib

Index

Type Aliases

AddCodeComponentParams -AddExternalTreeParams -AddLinkComponentParams -AddPdfComponentParams -ChangeManifestParams -ComponentParam -CreateDraftParams -CreateDraftResponse -CreateFolderParams -CreateFolderResponse -DeleteDataParams -DeleteDataResponse -ExternalUrl -IndexedNode -IndexedNodeVersion -ListedNode -ManifestDocumentResponse -MoveDataParams -MoveDataResponse -NodeResponse -PrepublishResponse -PublishResponse -RetrieveResponse -UpdateComponentParams -UploadFilesResponse -UploadGithubRepoFromUrlParams -UploadParams -UploadPdfFromUrlParams -

Functions

addCodeComponent -addContributor -addExternalUnixFsTree -addLinkComponent -addPdfComponent -addRawComponent -changeManifest -createDraftNode -createNewFolder -deleteComponent -deleteData -deleteDraftNode -getDpidHistory -getDraftNode -listNodes -moveData -prePublishDraftNode -publishDraftNode -removeContributor -retrieveDraftFileTree -updateComponent -updateCoverImage -updateDescription -updateLicense -updateResearchFields -updateTitle -uploadFiles -uploadGithubRepoFromUrl -uploadPdfFromUrl -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/AddCodeComponentParams.html b/nodes-lib/docs/types/AddCodeComponentParams.html deleted file mode 100644 index 3fb64eb41..000000000 --- a/nodes-lib/docs/types/AddCodeComponentParams.html +++ /dev/null @@ -1,8 +0,0 @@ -AddCodeComponentParams | @desci-labs/nodes-lib

Type alias AddCodeComponentParams

AddCodeComponentParams: {
    cid: string;
    language: string;
    name: string;
    path: string;
    starred: boolean;
    subtype: ResearchObjectComponentCodeSubtype;
}

Parameters for adding code component to manifest. These can be -nested in layers to mark subdirectories as other types of code, etc.

-

Type declaration

  • cid: string

    CID of the target file or unixFS directory

    -
  • language: string
  • name: string

    Human-readable name of the code collection

    -
  • path: string

    Absolute path to the code in the drive

    -
  • starred: boolean

    Wether to show the document as a central component of the object

    -
  • subtype: ResearchObjectComponentCodeSubtype

    Indicates the type of document

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/AddExternalTreeParams.html b/nodes-lib/docs/types/AddExternalTreeParams.html deleted file mode 100644 index 2b9be8940..000000000 --- a/nodes-lib/docs/types/AddExternalTreeParams.html +++ /dev/null @@ -1,7 +0,0 @@ -AddExternalTreeParams | @desci-labs/nodes-lib

Type alias AddExternalTreeParams

AddExternalTreeParams: {
    componentSubtype: ResearchObjectComponentSubtypes;
    componentType: ResearchObjectComponentType;
    externalCids: {
        cid: string;
        name: string;
    }[];
    targetPath: string;
    uuid: string;
}

Parameters requried for adding an externally pinned file or UnixFS tree

-

Type declaration

  • componentSubtype: ResearchObjectComponentSubtypes

    The subtype of the imported data

    -
  • componentType: ResearchObjectComponentType

    The type of the imported data

    -
  • externalCids: {
        cid: string;
        name: string;
    }[]

    Which external CIDs to include, and their associated names in the drive

    -
  • targetPath: string

    The absolute path in the drive where the entries should be

    -
  • uuid: string

    The node to add the data to

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/AddLinkComponentParams.html b/nodes-lib/docs/types/AddLinkComponentParams.html deleted file mode 100644 index bd0f9d936..000000000 --- a/nodes-lib/docs/types/AddLinkComponentParams.html +++ /dev/null @@ -1,6 +0,0 @@ -AddLinkComponentParams | @desci-labs/nodes-lib

Type alias AddLinkComponentParams

AddLinkComponentParams: {
    name: string;
    starred: boolean;
    subtype: ResearchObjectComponentLinkSubtype;
    url: string;
}

Parameters for adding an external link component to manifest

-

Type declaration

  • name: string

    Human-readable name of component

    -
  • starred: boolean

    Wether to show the link as a central component of the object

    -
  • subtype: ResearchObjectComponentLinkSubtype

    Which type of resource the link points to

    -
  • url: string

    Link component refers to

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/AddPdfComponentParams.html b/nodes-lib/docs/types/AddPdfComponentParams.html deleted file mode 100644 index 32306420f..000000000 --- a/nodes-lib/docs/types/AddPdfComponentParams.html +++ /dev/null @@ -1,8 +0,0 @@ -AddPdfComponentParams | @desci-labs/nodes-lib

Type alias AddPdfComponentParams

AddPdfComponentParams: {
    cid: string;
    name: string;
    pathToFile: string;
    starred: boolean;
    subtype: ResearchObjectComponentDocumentSubtype;
}

Parameters for adding a PDF component to manifest. This is done after -uploading the file, and allows adding richer metadata to the document.

-

Type declaration

  • cid: string

    CID of the file

    -
  • name: string

    Human-readable name of the document

    -
  • pathToFile: string

    Absolute path to the file in the drive

    -
  • starred: boolean

    Wether to show the document as a central component of the object

    -
  • subtype: ResearchObjectComponentDocumentSubtype

    Indicates the type of document

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/ChangeManifestParams.html b/nodes-lib/docs/types/ChangeManifestParams.html deleted file mode 100644 index b29c9f40a..000000000 --- a/nodes-lib/docs/types/ChangeManifestParams.html +++ /dev/null @@ -1,4 +0,0 @@ -ChangeManifestParams | @desci-labs/nodes-lib

Type alias ChangeManifestParams

ChangeManifestParams: {
    actions: ManifestActions[];
    uuid: string;
}

Parameters requried for changing the manifest

-

Type declaration

  • actions: ManifestActions[]

    One or more actions to perform

    -
  • uuid: string

    The node to change the manifest of

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/ComponentParam.html b/nodes-lib/docs/types/ComponentParam.html deleted file mode 100644 index b486913dc..000000000 --- a/nodes-lib/docs/types/ComponentParam.html +++ /dev/null @@ -1 +0,0 @@ -ComponentParam | @desci-labs/nodes-lib

Type alias ComponentParam

ComponentParam: PdfComponent | ExternalLinkComponent | DataComponent | CodeComponent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/CreateDraftParams.html b/nodes-lib/docs/types/CreateDraftParams.html deleted file mode 100644 index 98b8eae9e..000000000 --- a/nodes-lib/docs/types/CreateDraftParams.html +++ /dev/null @@ -1,6 +0,0 @@ -CreateDraftParams | @desci-labs/nodes-lib

Type alias CreateDraftParams

CreateDraftParams: {
    defaultLicense: License;
    links: {
        metadata: string[];
        pdf: string[];
    };
    researchFields: ResearchField[];
    title: string;
}

Required parameters for creating a new draft node

-

Type declaration

  • defaultLicense: License

    The license that should apply to the content of the node

    -
  • links: {
        metadata: string[];
        pdf: string[];
    }

    Must be included for backward compatibility

    -
    • metadata: string[]
    • pdf: string[]
  • researchFields: ResearchField[]

    Research fields the node is associated with

    -
  • title: string

    Human-readable title of the node

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/CreateDraftResponse.html b/nodes-lib/docs/types/CreateDraftResponse.html deleted file mode 100644 index fb5a146f5..000000000 --- a/nodes-lib/docs/types/CreateDraftResponse.html +++ /dev/null @@ -1,3 +0,0 @@ -CreateDraftResponse | @desci-labs/nodes-lib

Type alias CreateDraftResponse

CreateDraftResponse: {
    documentId: string;
    hash: string;
    node: NodeResponse;
    ok: boolean;
    uri: string;
    version: NodeVersion;
}

Nodes backend response after creating a draft, containing information -about the state of the draft node.

-

Type declaration

  • documentId: string
  • hash: string
  • node: NodeResponse
  • ok: boolean
  • uri: string
  • version: NodeVersion

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/CreateFolderParams.html b/nodes-lib/docs/types/CreateFolderParams.html deleted file mode 100644 index 7d73d248b..000000000 --- a/nodes-lib/docs/types/CreateFolderParams.html +++ /dev/null @@ -1,5 +0,0 @@ -CreateFolderParams | @desci-labs/nodes-lib

Type alias CreateFolderParams

CreateFolderParams: {
    folderName: string;
    locationPath: string;
    uuid: string;
}

Parameters required for creating a new directory in the drive

-

Type declaration

  • folderName: string

    The name of the new folder (UNIX basename)

    -
  • locationPath: string

    The location of the new folder (UNIX dirname)

    -
  • uuid: string

    The node to create a new folder in

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/CreateFolderResponse.html b/nodes-lib/docs/types/CreateFolderResponse.html deleted file mode 100644 index 216c11e7f..000000000 --- a/nodes-lib/docs/types/CreateFolderResponse.html +++ /dev/null @@ -1,6 +0,0 @@ -CreateFolderResponse | @desci-labs/nodes-lib

Type alias CreateFolderResponse

CreateFolderResponse: {
    date: string;
    manifest: ResearchObjectV1;
    manifestCid: string;
    tree: DriveObject[];
}

Response from creating a new directory

-

Type declaration

  • date: string

    Timestamp of the change

    -
  • manifest: ResearchObjectV1

    The new state of the manifest

    -
  • manifestCid: string

    The new manifest CID

    -
  • tree: DriveObject[]

    The new state of the drive tree

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/DeleteDataParams.html b/nodes-lib/docs/types/DeleteDataParams.html deleted file mode 100644 index 461f3ec3d..000000000 --- a/nodes-lib/docs/types/DeleteDataParams.html +++ /dev/null @@ -1,4 +0,0 @@ -DeleteDataParams | @desci-labs/nodes-lib

Type alias DeleteDataParams

DeleteDataParams: {
    path: string;
    uuid: string;
}

Parameters required for deleting a drive entry

-

Type declaration

  • path: string

    (absolute) drive path to delete. Can be a directory.

    -
  • uuid: string

    The node to delete from

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/DeleteDataResponse.html b/nodes-lib/docs/types/DeleteDataResponse.html deleted file mode 100644 index 81ffc2707..000000000 --- a/nodes-lib/docs/types/DeleteDataResponse.html +++ /dev/null @@ -1,4 +0,0 @@ -DeleteDataResponse | @desci-labs/nodes-lib

Type alias DeleteDataResponse

DeleteDataResponse: {
    manifest: ResearchObjectV1;
    manifestCid: string;
}

Response from a delete operation, where components may have been removed

-

Type declaration

  • manifest: ResearchObjectV1

    The new state of the manifest

    -
  • manifestCid: string

    New CID of the manifest

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/ExternalUrl.html b/nodes-lib/docs/types/ExternalUrl.html deleted file mode 100644 index 5253b3014..000000000 --- a/nodes-lib/docs/types/ExternalUrl.html +++ /dev/null @@ -1,5 +0,0 @@ -ExternalUrl | @desci-labs/nodes-lib

Type alias ExternalUrl

ExternalUrl: {
    path: string;
    url: string;
}

Reference to externally hosted data to upload. Capable of handling -pdf or github repos at the moment.

-

Type declaration

  • path: string

    Name of the file or code repo (not the full path)

    -
  • url: string

    Web URL to the target resource

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/IndexedNode.html b/nodes-lib/docs/types/IndexedNode.html deleted file mode 100644 index 3bfd59882..000000000 --- a/nodes-lib/docs/types/IndexedNode.html +++ /dev/null @@ -1,7 +0,0 @@ -IndexedNode | @desci-labs/nodes-lib

Type alias IndexedNode

IndexedNode: {
    id: string;
    id10: string;
    owner: string;
    recentCid: string;
    versions: IndexedNodeVersion[];
}

Represents the state and publication history of a dPID

-

Type declaration

  • id: string

    Node UUID in hex

    -
  • id10: string

    Node UUID in decimal

    -
  • owner: string

    Account who owns the node

    -
  • recentCid: string

    The most recent manifest CID

    -
  • versions: IndexedNodeVersion[]

    Publication history of the node

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/IndexedNodeVersion.html b/nodes-lib/docs/types/IndexedNodeVersion.html deleted file mode 100644 index 6446d8a2b..000000000 --- a/nodes-lib/docs/types/IndexedNodeVersion.html +++ /dev/null @@ -1,5 +0,0 @@ -IndexedNodeVersion | @desci-labs/nodes-lib

Type alias IndexedNodeVersion

IndexedNodeVersion: {
    cid: string;
    id: string;
    time: string;
}

Historical log entry for a dPID

-

Type declaration

  • cid: string

    Manifest CID in EVM format

    -
  • id: string

    Transaction ID of the update event

    -
  • time: string

    Epoch timestamp of the update

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/ListedNode.html b/nodes-lib/docs/types/ListedNode.html deleted file mode 100644 index da36fd909..000000000 --- a/nodes-lib/docs/types/ListedNode.html +++ /dev/null @@ -1,2 +0,0 @@ -ListedNode | @desci-labs/nodes-lib

Type alias ListedNode

ListedNode: {
    NodeCover: any[];
    cid: string;
    createdAt: string;
    id: string;
    index?: IndexedNode[];
    isPublished: boolean;
    manifestUrl: string;
    ownerId: number;
    title: string;
    updatedAt: string;
    uuid: string;
}

Information returned when listing user nodes, published and private drafts.

-

Type declaration

  • NodeCover: any[]
  • cid: string
  • createdAt: string
  • id: string
  • Optional index?: IndexedNode[]
  • isPublished: boolean
  • manifestUrl: string
  • ownerId: number
  • title: string
  • updatedAt: string
  • uuid: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/ManifestDocumentResponse.html b/nodes-lib/docs/types/ManifestDocumentResponse.html deleted file mode 100644 index 89579e4e7..000000000 --- a/nodes-lib/docs/types/ManifestDocumentResponse.html +++ /dev/null @@ -1,4 +0,0 @@ -ManifestDocumentResponse | @desci-labs/nodes-lib

Type alias ManifestDocumentResponse

ManifestDocumentResponse: {
    document: ResearchObjectDocument;
    documentId: string;
}

Response from a manifest change request

-

Type declaration

  • document: ResearchObjectDocument

    The state of the manifest document

    -
  • documentId: string

    The (internal) automerge ID of the manifest

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/MoveDataParams.html b/nodes-lib/docs/types/MoveDataParams.html deleted file mode 100644 index e7bdd06f6..000000000 --- a/nodes-lib/docs/types/MoveDataParams.html +++ /dev/null @@ -1,5 +0,0 @@ -MoveDataParams | @desci-labs/nodes-lib

Type alias MoveDataParams

MoveDataParams: {
    newPath: string;
    oldPath: string;
    uuid: string;
}

Parameters required for moving data in the drive

-

Type declaration

  • newPath: string

    The new location of the data

    -
  • oldPath: string

    The path of the data to move

    -
  • uuid: string

    The node to move data in

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/MoveDataResponse.html b/nodes-lib/docs/types/MoveDataResponse.html deleted file mode 100644 index 4a073e393..000000000 --- a/nodes-lib/docs/types/MoveDataResponse.html +++ /dev/null @@ -1,2 +0,0 @@ -MoveDataResponse | @desci-labs/nodes-lib

Type alias MoveDataResponse

MoveDataResponse: {
    manifest: ResearchObjectV1;
    manifestCid: string;
}

Response from a move operation, where components may have been updated

-

Type declaration

  • manifest: ResearchObjectV1
  • manifestCid: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/NodeResponse.html b/nodes-lib/docs/types/NodeResponse.html deleted file mode 100644 index c02fa44a4..000000000 --- a/nodes-lib/docs/types/NodeResponse.html +++ /dev/null @@ -1,5 +0,0 @@ -NodeResponse | @desci-labs/nodes-lib

Type alias NodeResponse

NodeResponse: {
    ceramicStream?: string;
    cid: string;
    createdAt: string;
    deletedAt?: string;
    id: number;
    isDeleted: boolean;
    isFeatured: boolean;
    manifestData: ResearchObjectV1;
    manifestDocumentId: string;
    manifestUrl: string;
    ownerId: number;
    replicationFactor: number;
    state: string;
    title: string;
    updatedAt: string;
    uuid: string;
}

Full state of a draft node as the backend is aware.

-

Note that the data drive in the manifest, and hence -the manifest CID, may not reflect the actual drive state -until the node is published (or prePublishDraftNode is called).

-

Type declaration

  • Optional ceramicStream?: string
  • cid: string
  • createdAt: string
  • Optional deletedAt?: string
  • id: number
  • isDeleted: boolean
  • isFeatured: boolean
  • manifestData: ResearchObjectV1
  • manifestDocumentId: string
  • manifestUrl: string
  • ownerId: number
  • replicationFactor: number
  • state: string
  • title: string
  • updatedAt: string
  • uuid: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/PrepublishResponse.html b/nodes-lib/docs/types/PrepublishResponse.html deleted file mode 100644 index 41dfd2a2f..000000000 --- a/nodes-lib/docs/types/PrepublishResponse.html +++ /dev/null @@ -1,3 +0,0 @@ -PrepublishResponse | @desci-labs/nodes-lib

Type alias PrepublishResponse

PrepublishResponse: {
    ceramicStream?: string;
    ok: boolean;
    updatedManifest: ResearchObjectV1;
    updatedManifestCid: string;
    version?: NodeVersion;
}

Response from prepublishing a node, containing the drive CID -computed from draft state.

-

Type declaration

  • Optional ceramicStream?: string
  • ok: boolean
  • updatedManifest: ResearchObjectV1
  • updatedManifestCid: string
  • Optional version?: NodeVersion

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/PublishResponse.html b/nodes-lib/docs/types/PublishResponse.html deleted file mode 100644 index e4d899331..000000000 --- a/nodes-lib/docs/types/PublishResponse.html +++ /dev/null @@ -1,5 +0,0 @@ -PublishResponse | @desci-labs/nodes-lib

Type alias PublishResponse

PublishResponse: {
    ceramicIDs?: NodeIDs;
    ok: boolean;
    updatedManifestCid: string;
}

Result of publishing a draft node

-

Type declaration

  • Optional ceramicIDs?: NodeIDs

    Ceramic stream and commit IDs from publishing to Codex

    -
  • ok: boolean

    Publish status

    -
  • updatedManifestCid: string

    The new manifest CID, which could have changed from adding the dPID

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/RetrieveResponse.html b/nodes-lib/docs/types/RetrieveResponse.html deleted file mode 100644 index d43047678..000000000 --- a/nodes-lib/docs/types/RetrieveResponse.html +++ /dev/null @@ -1,5 +0,0 @@ -RetrieveResponse | @desci-labs/nodes-lib

Type alias RetrieveResponse

RetrieveResponse: {
    date: string;
    status?: number;
    tree: DriveObject[];
}

Response from retrieving the state of the drive tree

-

Type declaration

  • date: string

    The timestamp of latest drive change

    -
  • Optional status?: number

    Status code of the retrieval

    -
  • tree: DriveObject[]

    Recursive structure describing the drive state

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/UpdateComponentParams.html b/nodes-lib/docs/types/UpdateComponentParams.html deleted file mode 100644 index 645494b8f..000000000 --- a/nodes-lib/docs/types/UpdateComponentParams.html +++ /dev/null @@ -1,4 +0,0 @@ -UpdateComponentParams | @desci-labs/nodes-lib

Type alias UpdateComponentParams

UpdateComponentParams: {
    component: ResearchObjectV1Component;
    componentIndex: number;
}

Update the content of a component.

-

Type declaration

  • component: ResearchObjectV1Component

    The new component data

    -
  • componentIndex: number

    Which component index to update

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/UploadFilesResponse.html b/nodes-lib/docs/types/UploadFilesResponse.html deleted file mode 100644 index 8ceda92ac..000000000 --- a/nodes-lib/docs/types/UploadFilesResponse.html +++ /dev/null @@ -1,6 +0,0 @@ -UploadFilesResponse | @desci-labs/nodes-lib

Type alias UploadFilesResponse

UploadFilesResponse: {
    date: string;
    manifest: ResearchObjectV1;
    manifestCid: string;
    tree: DriveObject[];
}

Response from uploading files

-

Type declaration

  • date: string

    Timestamp of the change

    -
  • manifest: ResearchObjectV1

    The new state of the manifest

    -
  • manifestCid: string

    The new manifest CID

    -
  • tree: DriveObject[]

    The new state of the drive tree

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/UploadGithubRepoFromUrlParams.html b/nodes-lib/docs/types/UploadGithubRepoFromUrlParams.html deleted file mode 100644 index 9883bf0c1..000000000 --- a/nodes-lib/docs/types/UploadGithubRepoFromUrlParams.html +++ /dev/null @@ -1,6 +0,0 @@ -UploadGithubRepoFromUrlParams | @desci-labs/nodes-lib

Type alias UploadGithubRepoFromUrlParams

UploadGithubRepoFromUrlParams: {
    componentSubtype: ResearchObjectComponentCodeSubtype;
    externalUrl: ExternalUrl;
    targetPath: string;
    uuid: string;
}

Parameters required for uploading an external GitHub code repository

-

Type declaration

  • componentSubtype: ResearchObjectComponentCodeSubtype

    What type of code the repo contains

    -
  • externalUrl: ExternalUrl

    Web URL to the target repo, and its name

    -
  • targetPath: string

    Target path in the drive (folders must exist beforehand)

    -
  • uuid: string

    The node to upload the repo to

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/UploadParams.html b/nodes-lib/docs/types/UploadParams.html deleted file mode 100644 index 0dc45b43f..000000000 --- a/nodes-lib/docs/types/UploadParams.html +++ /dev/null @@ -1,6 +0,0 @@ -UploadParams | @desci-labs/nodes-lib

Type alias UploadParams

UploadParams: {
    localFilePaths: string[];
    targetPath: string;
    uuid: string;
}

Parameters required to upload a set of files

-

Type declaration

  • localFilePaths: string[]

    Local paths to files for upload

    -
  • targetPath: string

    Absolute path to target location in drive. -Note that folders must already exist.

    -
  • uuid: string

    The node to upload files to

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/nodes-lib/docs/types/UploadPdfFromUrlParams.html b/nodes-lib/docs/types/UploadPdfFromUrlParams.html deleted file mode 100644 index 8e4e9eddd..000000000 --- a/nodes-lib/docs/types/UploadPdfFromUrlParams.html +++ /dev/null @@ -1,6 +0,0 @@ -UploadPdfFromUrlParams | @desci-labs/nodes-lib

Type alias UploadPdfFromUrlParams

UploadPdfFromUrlParams: {
    componentSubtype: ResearchObjectComponentDocumentSubtype;
    externalUrl: ExternalUrl;
    targetPath: string;
    uuid: string;
}

Parameters required for uploading an externally hosted PDF file

-

Type declaration

  • componentSubtype: ResearchObjectComponentDocumentSubtype

    What type of document the target file is

    -
  • externalUrl: ExternalUrl

    Web URL to the target document, and its filename

    -
  • targetPath: string

    Target path in the drive (folders must already exist)

    -
  • uuid: string

    The node to uppload the document to

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file