doc-update

README.md

@@ -77,22 +77,7 @@ $ npm install @seneca/trello-provider @seneca/env
 
 ## Options
 
-* `debug` : boolean <i><small>false</small></i>
-
-
-Set plugin options when loading with:
-```js
-
-
-seneca.use('TrelloProvider', { name: value, ... })
-
-
-```
-
-
-<small>Note: <code>foo.bar</code> in the list above means 
-<code>{ foo: { bar: ... } }</code></small> 
-
+*None.*
 
 
 <!--END:options-->
@@ -102,9 +87,10 @@ seneca.use('TrelloProvider', { name: value, ... })
 
 ## Action Patterns
 
-* [role:entity,base:trello,cmd:load,name:repo,zone:provider](#-roleentitybasetrellocmdloadnamerepozoneprovider-)
-* [role:entity,base:trello,cmd:save,name:repo,zone:provider](#-roleentitybasetrellocmdsavenamerepozoneprovider-)
-* [sys:provider,get:info,provider:trello](#-sysprovidergetinfoprovidertrello-)
+* ["role":"entity","base":"trello","cmd":"list","name":"board","zone":"provider"](#-roleentitybasetrellocmdlistnameboardzoneprovider-)
+* ["role":"entity","base":"trello","cmd":"load","name":"board","zone":"provider"](#-roleentitybasetrellocmdloadnameboardzoneprovider-)
+* ["role":"entity","base":"trello","cmd":"save","name":"board","zone":"provider"](#-roleentitybasetrellocmdsavenameboardzoneprovider-)
+* ["sys":"provider","get":"info","provider":"trello"](#-sysprovidergetinfoprovidertrello-)
 
 
 <!--END:action-list-->
@@ -114,23 +100,30 @@ seneca.use('TrelloProvider', { name: value, ... })
 
 ## Action Descriptions
 
-### &laquo; `role:entity,base:trello,cmd:load,name:repo,zone:provider` &raquo;
+### &laquo; `"role":"entity","base":"trello","cmd":"list","name":"board","zone":"provider"` &raquo;
+
+List Trello data into an entity
+
+
+
+----------
+### &laquo; `"role":"entity","base":"trello","cmd":"load","name":"board","zone":"provider"` &raquo;
 
-Load Trello repository data into an entity.
+Load Trello data into an entity
 
 
 
 ----------
-### &laquo; `role:entity,base:trello,cmd:save,name:repo,zone:provider` &raquo;
+### &laquo; `"role":"entity","base":"trello","cmd":"save","name":"board","zone":"provider"` &raquo;
 
-Update Trello repository data from an entity.
+Save/Update Trello data into an entity
 
 
 
 ----------
-### &laquo; `sys:provider,get:info,provider:trello` &raquo;
+### &laquo; `"sys":"provider","get":"info","provider":"trello"` &raquo;
 
-Get information about the provider.
+Get information about the Trello SDK.
 
 
 

dist/TrelloProvider-doc.d.ts

@@ -0,0 +1,18 @@
+declare const _default: {
+    messages: {
+        get_info: {
+            desc: string;
+        };
+        save_board: {
+            desc: string;
+        };
+        load_board: {
+            desc: string;
+        };
+        list_board: {
+            desc: string;
+        };
+    };
+    sections: {};
+};
+export default _default;

dist/trello-provider.d.ts

@@ -0,0 +1,7 @@
+type TrelloProviderOptions = {};
+declare function TrelloProvider(this: any, _options: TrelloProviderOptions): {
+    exports: {
+        sdk: () => any;
+    };
+};
+export default TrelloProvider;

package.json

@@ -23,7 +23,7 @@
     "test-watch": "jest --coverage --watchAll",
     "watch": "tsc -w -d",
     "build": "tsc -d",
-    "doc": "echo seneca-doc -p @seneca/provider FIX-broken",
+    "doc": "seneca-doc -p @seneca/provider FIX-broken",
     "clean": "rm -rf node_modules dist yarn.lock package-lock.json",
     "reset": "npm run clean && npm i && npm test",
     "repo-tag": "REPO_VERSION=`node -e \"console.log(require('./package').version)\"` && echo TAG: v$REPO_VERSION && git commit -a -m v$REPO_VERSION && git push && git tag v$REPO_VERSION && git push --tags;",
@@ -50,7 +50,7 @@
     "@seneca/env": ">=0.2"
   },
   "devDependencies": {
-    "@seneca/doc": "^4.1.0",
+    "@seneca/doc": "^4.2.4",
     "@seneca/maintain": "0.0.28",
     "@types/jest": "^28.1.4",
     "@types/node": "^18.0.3",

src/TrelloProvider-doc.ts

@@ -1,16 +1,34 @@
 /* Copyright © 2022 Seneca Project Contributors, MIT License. */
 
 
-const docs = {
+const messages = {
 
   get_info: {
     desc: 'Get information about the Trello SDK.',
   },
 
+  save_board: {
+    desc: 'Save/Update Trello data into an entity',
+  },
+  load_board: {
+    desc: 'Load Trello data into an entity',
+  },
+  list_board: {
+    desc: 'List Trello data into an entity',
+  },
+
 }
 
-export default docs
+const sections = {}
+
+export default {
+  messages,
+  sections
+}
 
 if ('undefined' !== typeof (module)) {
-  module.exports = docs
+  module.exports = {
+    messages,
+    sections
+  }
 }