@voxgig/sdkgen 0.32.2 → 0.33.0

package/bin/voxgig-sdkgen

@@ -8,7 +8,7 @@ const { Gubu, Fault, One } = require('gubu')
 
 const { SdkGen } = require('../dist/sdkgen.js')
 
-const VERSION = '0.32.2'
+const VERSION = '0.33.0'
 const KONSOLE = console
 
 

package/dist/cmp/Readme.js

@@ -8,6 +8,7 @@ const ReadmeQuick_1 = require("./ReadmeQuick");
 const ReadmeModel_1 = require("./ReadmeModel");
 const ReadmeOptions_1 = require("./ReadmeOptions");
 const ReadmeEntity_1 = require("./ReadmeEntity");
+const ReadmeRef_1 = require("./ReadmeRef");
 const Readme = (0, jostraca_1.cmp)(function Readme(props) {
     const { target } = props;
     const { model } = props.ctx$;
@@ -22,7 +23,16 @@ const Readme = (0, jostraca_1.cmp)(function Readme(props) {
         (0, ReadmeModel_1.ReadmeModel)({ target });
         (0, ReadmeOptions_1.ReadmeOptions)({ target });
         (0, ReadmeEntity_1.ReadmeEntity)({ target });
+        (0, jostraca_1.Content)(`
+## Reference
+
+See [REFERENCE.md](REFERENCE.md) for complete API reference
+documentation including all method signatures, entity field schemas,
+and detailed usage examples.
+`);
     });
+    // Generate separate reference documentation
+    (0, ReadmeRef_1.ReadmeRef)({ target });
 });
 exports.Readme = Readme;
 //# sourceMappingURL=Readme.js.map

package/dist/cmp/Readme.js.map

@@ -1 +1 @@
-{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,+CAA2C;AAC3C,mDAA+C;AAC/C,+CAA2C;AAC3C,+CAA2C;AAC3C,mDAA+C;AAC/C,iDAA6C;AAG7C,MAAM,MAAM,GAAG,IAAA,cAAG,EAAC,SAAS,MAAM,CAAC,KAAU;IAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,kBAAO,EAAC;IACR,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK;CAC7B,CAAC,CAAA;QACE,WAAW;QACX,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,2BAAY,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC1B,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAIA,wBAAM"}
+{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,+CAA2C;AAC3C,mDAA+C;AAC/C,+CAA2C;AAC3C,+CAA2C;AAC3C,mDAA+C;AAC/C,iDAA6C;AAC7C,2CAAuC;AAGvC,MAAM,MAAM,GAAG,IAAA,cAAG,EAAC,SAAS,MAAM,CAAC,KAAU;IAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,kBAAO,EAAC;IACR,KAAK,CAAC,IAAI,IAAI,MAAM,CAAC,KAAK;CAC7B,CAAC,CAAA;QACE,WAAW;QACX,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,yBAAW,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACvB,IAAA,6BAAa,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QACzB,IAAA,2BAAY,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;QAExB,IAAA,kBAAO,EAAC;;;;;;CAMX,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,4CAA4C;IAC5C,IAAA,qBAAS,EAAC,EAAE,MAAM,EAAE,CAAC,CAAA;AACvB,CAAC,CAAC,CAAA;AAIA,wBAAM"}

package/dist/cmp/ReadmeEntity.js

@@ -3,26 +3,109 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeEntity = void 0;
 const jostraca_1 = require("jostraca");
 const types_1 = require("../types");
+const OP_DESC = {
+    load: { method: 'load(match)', desc: 'Load a single entity by match criteria.' },
+    list: { method: 'list(match)', desc: 'List entities matching the criteria.' },
+    create: { method: 'create(data)', desc: 'Create a new entity with the given data.' },
+    update: { method: 'update(data)', desc: 'Update an existing entity.' },
+    remove: { method: 'remove(match)', desc: 'Remove the matching entity.' },
+};
 const ReadmeEntity = (0, jostraca_1.cmp)(function ReadmeEntity(props) {
     const { ctx$: { model } } = props;
     const entity = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.entity`);
+    const publishedEntities = (0, jostraca_1.each)(entity)
+        .filter((entity) => entity.publish);
+    if (0 === publishedEntities.length) {
+        return;
+    }
     (0, jostraca_1.Content)(`
 
 ## Entities
+
 `);
-    (0, jostraca_1.each)(entity)
-        .filter((entity) => entity.publish)
-        .map((entity) => {
+    publishedEntities.map((entity) => {
+        const opnames = Object.keys(entity.op || {});
+        const fields = entity.field || [];
         (0, jostraca_1.Content)(`
-### Entity: __${entity.Name}__
+### ${entity.Name}
+
+`);
+        if (entity.short) {
+            (0, jostraca_1.Content)(`${entity.short}
+
+`);
+        }
+        (0, jostraca_1.Content)(`Create an instance: \`const ${entity.name} = client.${entity.Name}()\`
+
+`);
+        // Operations table
+        if (opnames.length > 0) {
+            (0, jostraca_1.Content)(`#### Operations
+
+| Method | Description |
+| --- | --- |
+`);
+            opnames.map((opname) => {
+                const info = OP_DESC[opname];
+                if (info) {
+                    (0, jostraca_1.Content)(`| \`${info.method}\` | ${info.desc} |
+`);
+                }
+            });
+            (0, jostraca_1.Content)(`
+`);
+        }
+        // Fields table
+        if (fields.length > 0) {
+            (0, jostraca_1.Content)(`#### Fields
 
+| Field | Type | Description |
+| --- | --- | --- |
 `);
-        (0, jostraca_1.each)(entity.field, (field) => {
+            (0, jostraca_1.each)(fields, (field) => {
+                const desc = field.short || '';
+                (0, jostraca_1.Content)(`| \`${field.name}\` | \`${field.type || 'any'}\` | ${desc} |
+`);
+            });
             (0, jostraca_1.Content)(`
-* __${field.name}__ (${field.type}): ${field.short}
-  
 `);
-        });
+        }
+        // Example usage
+        if (opnames.includes('load')) {
+            (0, jostraca_1.Content)(`#### Example: Load
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().load({ id: '${entity.name}_id' })
+\`\`\`
+
+`);
+        }
+        if (opnames.includes('list')) {
+            (0, jostraca_1.Content)(`#### Example: List
+
+\`\`\`ts
+const ${entity.name}s = await client.${entity.Name}().list()
+\`\`\`
+
+`);
+        }
+        if (opnames.includes('create')) {
+            (0, jostraca_1.Content)(`#### Example: Create
+
+\`\`\`ts
+const ${entity.name} = await client.${entity.Name}().create({
+`);
+            (0, jostraca_1.each)(fields, (field) => {
+                if ('id' !== field.name && field.req) {
+                    (0, jostraca_1.Content)(`  ${field.name}: /* ${field.type || 'value'} */,
+`);
+                }
+            });
+            (0, jostraca_1.Content)(`})
+\`\`\`
+
+`);
+        }
     });
 });
 exports.ReadmeEntity = ReadmeEntity;

package/dist/cmp/ReadmeEntity.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeEntity.js","sourceRoot":"","sources":["../../src/cmp/ReadmeEntity.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAGjB,MAAM,YAAY,GAAG,IAAA,cAAG,EAAC,SAAS,YAAY,CAAC,KAAU;IACvD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IAExD,IAAA,kBAAO,EAAC;;;CAGT,CAAC,CAAA;IAGA,IAAA,eAAI,EAAC,MAAM,CAAC;SACT,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACnB,IAAA,kBAAO,EAAC;gBACE,MAAM,CAAC,IAAI;;CAE1B,CAAC,CAAA;QAEI,IAAA,eAAI,EAAC,MAAM,CAAC,KAAK,EAAE,CAAC,KAAU,EAAE,EAAE;YAChC,IAAA,kBAAO,EAAC;MACV,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,KAAK;;CAEjD,CAAC,CAAA;QACI,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AAGN,CAAC,CAAC,CAAA;AAKA,oCAAY"}
+{"version":3,"file":"ReadmeEntity.js","sourceRoot":"","sources":["../../src/cmp/ReadmeEntity.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAGjB,MAAM,OAAO,GAAqD;IAChE,IAAI,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,yCAAyC,EAAE;IAChF,IAAI,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,IAAI,EAAE,sCAAsC,EAAE;IAC7E,MAAM,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,0CAA0C,EAAE;IACpF,MAAM,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,IAAI,EAAE,4BAA4B,EAAE;IACtE,MAAM,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,IAAI,EAAE,6BAA6B,EAAE;CACzE,CAAA;AAGD,MAAM,YAAY,GAAG,IAAA,cAAG,EAAC,SAAS,YAAY,CAAC,KAAU;IACvD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IAExD,MAAM,iBAAiB,GAAG,IAAA,eAAI,EAAC,MAAM,CAAC;SACnC,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAE1C,IAAI,CAAC,KAAK,iBAAiB,CAAC,MAAM,EAAE,CAAC;QACnC,OAAM;IACR,CAAC;IAED,IAAA,kBAAO,EAAC;;;;CAIT,CAAC,CAAA;IAEA,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACpC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,CAAC,CAAA;QAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE,CAAA;QAEjC,IAAA,kBAAO,EAAC;MACN,MAAM,CAAC,IAAI;;CAEhB,CAAC,CAAA;QAEE,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,IAAA,kBAAO,EAAC,GAAG,MAAM,CAAC,KAAK;;CAE5B,CAAC,CAAA;QACE,CAAC;QAED,IAAA,kBAAO,EAAC,+BAA+B,MAAM,CAAC,IAAI,aAAa,MAAM,CAAC,IAAI;;CAE7E,CAAC,CAAA;QAEE,mBAAmB;QACnB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,IAAA,kBAAO,EAAC;;;;CAIb,CAAC,CAAA;YACI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAc,EAAE,EAAE;gBAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;gBAC5B,IAAI,IAAI,EAAE,CAAC;oBACT,IAAA,kBAAO,EAAC,OAAO,IAAI,CAAC,MAAM,QAAQ,IAAI,CAAC,IAAI;CACpD,CAAC,CAAA;gBACM,CAAC;YACH,CAAC,CAAC,CAAA;YAEF,IAAA,kBAAO,EAAC;CACb,CAAC,CAAA;QACE,CAAC;QAED,eAAe;QACf,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,IAAA,kBAAO,EAAC;;;;CAIb,CAAC,CAAA;YAEI,IAAA,eAAI,EAAC,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE;gBAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,IAAI,EAAE,CAAA;gBAC9B,IAAA,kBAAO,EAAC,OAAO,KAAK,CAAC,IAAI,UAAU,KAAK,CAAC,IAAI,IAAI,KAAK,QAAQ,IAAI;CACzE,CAAC,CAAA;YACI,CAAC,CAAC,CAAA;YAEF,IAAA,kBAAO,EAAC;CACb,CAAC,CAAA;QACE,CAAC;QAED,gBAAgB;QAChB,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAA,kBAAO,EAAC;;;QAGN,MAAM,CAAC,IAAI,mBAAmB,MAAM,CAAC,IAAI,kBAAkB,MAAM,CAAC,IAAI;;;CAG7E,CAAC,CAAA;QACE,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAA,kBAAO,EAAC;;;QAGN,MAAM,CAAC,IAAI,oBAAoB,MAAM,CAAC,IAAI;;;CAGjD,CAAC,CAAA;QACE,CAAC;QAED,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,IAAA,kBAAO,EAAC;;;QAGN,MAAM,CAAC,IAAI,mBAAmB,MAAM,CAAC,IAAI;CAChD,CAAC,CAAA;YACI,IAAA,eAAI,EAAC,MAAM,EAAE,CAAC,KAAU,EAAE,EAAE;gBAC1B,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,EAAE,CAAC;oBACrC,IAAA,kBAAO,EAAC,KAAK,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,IAAI,OAAO;CAC7D,CAAC,CAAA;gBACM,CAAC;YACH,CAAC,CAAC,CAAA;YACF,IAAA,kBAAO,EAAC;;;CAGb,CAAC,CAAA;QACE,CAAC;IAEH,CAAC,CAAC,CAAA;AAEJ,CAAC,CAAC,CAAA;AAKA,oCAAY"}

package/dist/cmp/ReadmeIntro.js

@@ -2,12 +2,34 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeIntro = void 0;
 const jostraca_1 = require("jostraca");
+const types_1 = require("../types");
 const ReadmeIntro = (0, jostraca_1.cmp)(function ReadmeIntro(props) {
-    const { ctx$: { model } } = props;
+    const { target } = props;
+    const { model } = props.ctx$;
+    const desc = model.main.def.desc || '';
+    const entity = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.entity`);
+    const entityNames = Object.values(entity)
+        .filter((e) => e.publish)
+        .map((e) => `\`${e.Name}\``);
     (0, jostraca_1.Content)(`
 ## Introduction
 
-${model.main.def.desc}
+${desc}
+`);
+    if (entityNames.length > 0) {
+        (0, jostraca_1.Content)(`
+This SDK provides an entity-oriented interface for the ${model.Name} API.
+The following entities are available: ${entityNames.join(', ')}.
+
+`);
+    }
+    (0, jostraca_1.Content)(`
+### Features
+
+- Entity-based API: work with business objects directly.
+- Type safe: full TypeScript definitions included.
+- Direct HTTP access: call any API endpoint using \`client.direct()\`.
+- Testable: built-in test mode with mock support.
 
 `);
 });

package/dist/cmp/ReadmeIntro.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeIntro.js","sourceRoot":"","sources":["../../src/cmp/ReadmeIntro.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAGvC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,IAAA,kBAAO,EAAC;;;EAGR,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;;CAEpB,CAAC,CAAA;AAIF,CAAC,CAAC,CAAA;AAMA,kCAAW"}
+{"version":3,"file":"ReadmeIntro.js","sourceRoot":"","sources":["../../src/cmp/ReadmeIntro.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAEvC,oCAGiB;AAGjB,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAAA;IACtC,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IAExD,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;SACtC,MAAM,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;SAC7B,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,IAAI,CAAC,CAAA;IAEnC,IAAA,kBAAO,EAAC;;;EAGR,IAAI;CACL,CAAC,CAAA;IAEA,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,IAAA,kBAAO,EAAC;yDAC6C,KAAK,CAAC,IAAI;wCAC3B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;;CAE7D,CAAC,CAAA;IACA,CAAC;IAED,IAAA,kBAAO,EAAC;;;;;;;;CAQT,CAAC,CAAA;AAEF,CAAC,CAAC,CAAA;AAMA,kCAAW"}

package/dist/cmp/ReadmeModel.js

@@ -2,38 +2,115 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeModel = void 0;
 const jostraca_1 = require("jostraca");
+const types_1 = require("../types");
 const ReadmeModel = (0, jostraca_1.cmp)(function ReadmeModel(props) {
     const { ctx$: { model } } = props;
+    const entity = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.entity`);
+    const entityList = Object.values(entity).filter((e) => e.publish);
     (0, jostraca_1.Content)(`
-## Entity Model
+## SDK Structure
 
-This SDK uses an entity-oriented interface, rather than exposing
-endpoint paths directly.  Business logic can be mapped directly to
-business entities in your code.
+This SDK uses an entity-oriented interface rather than exposing API
+endpoint paths directly. Business logic maps directly to business
+entities in your code.
 
-The SDK itself allows you to create one or more client instances,
-which can be used concurrently in the same thread. Each client
-instance provides a set of entity methods to create entity
-instances. Each entity instance can likewise operate independently.
 
+### Client
 
-### SDK Methods
+Create a client instance using the constructor or the static \`test\` method:
 
-* \`make(options)\`: Create a new client instance. 
+\`\`\`ts
+// Production client
+const client = new ${model.Name}SDK({ apikey: '...' })
+
+// Test client with mock features
+const testClient = ${model.Name}SDK.test()
+\`\`\`
 
 
 ### Client Methods
 
-* \`[Entity]()\`: Create a new business entity instance. 
+| Method | Description |
+| --- | --- |
+`);
+    (0, jostraca_1.each)(entityList, (entity) => {
+        (0, jostraca_1.Content)(`| \`${entity.Name}(data?)\` | Create a new \`${entity.Name}\` entity instance. |
+`);
+    });
+    (0, jostraca_1.Content)(`| \`options()\` | Return a copy of the current SDK options. |
+| \`utility()\` | Return a copy of the SDK utility object. |
+| \`direct(fetchargs)\` | Make a direct HTTP request to any API endpoint. |
+| \`prepare(fetchargs)\` | Prepare a fetch definition without sending the request. |
+| \`tester(testopts?, sdkopts?)\` | Create a test client instance. |
 
 
 ### Entity Methods
 
-* \`data(data?)\`: Set the data properties of the entity, returning the current data.
-* \`load(query)\`: Load matching single entity data into the entity instance.
-* \`save(data?)\`: Save the current entity, optionally setting data.
-* \`list(query)\`: List matching entities, return an array of new entities.
-* \`remove(query)\`: Delete the matching single entity.
+Each entity instance provides the following methods, where available:
+
+| Method | Description |
+| --- | --- |
+| \`data(data?)\` | Get or set the entity data. Returns the current data. |
+| \`match(match?)\` | Get or set the entity match criteria. Returns the current match. |
+| \`load(match)\` | Load a single entity by match criteria. |
+| \`list(match)\` | List entities matching the criteria. Returns an array. |
+| \`create(data)\` | Create a new entity with the given data. |
+| \`update(data)\` | Update an existing entity with the given data. |
+| \`remove(match)\` | Remove the entity matching the criteria. |
+| \`make()\` | Create a new entity instance with the same options. |
+| \`client()\` | Return the parent client instance. |
+| \`entopts()\` | Return a copy of the entity options. |
+
+
+### Direct API Access
+
+The \`direct\` method allows you to call any API endpoint without
+using the entity interface:
+
+\`\`\`ts
+const result = await client.direct({
+  path: '/api/v1/resource/{id}',
+  method: 'GET',
+  params: { id: 'abc123' },
+  query: { fields: 'name,status' },
+  headers: { 'X-Custom': 'value' },
+  body: { key: 'value' },
+})
+\`\`\`
+
+The result object has the following shape:
+
+\`\`\`ts
+{
+  ok: boolean,     // true if status is 2xx
+  status: number,  // HTTP status code
+  headers: object, // Response headers
+  data: any,       // Parsed JSON response body
+}
+\`\`\`
+
+Use the \`prepare\` method to build the fetch definition without
+sending the request:
+
+\`\`\`ts
+const fetchdef = await client.prepare({
+  path: '/api/v1/resource',
+  method: 'POST',
+  body: { name: 'example' },
+})
+
+// fetchdef contains: { url, method, headers, body }
+\`\`\`
+
+
+### Testing
+
+Create a test client using the static \`test\` method. The test
+client activates the test feature, which provides mock responses:
+
+\`\`\`ts
+const client = ${model.Name}SDK.test()
+\`\`\`
 
 `);
 });

package/dist/cmp/ReadmeModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeModel.js","sourceRoot":"","sources":["../../src/cmp/ReadmeModel.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAGvC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BT,CAAC,CAAA;AAIF,CAAC,CAAC,CAAA;AAMA,kCAAW"}
+{"version":3,"file":"ReadmeModel.js","sourceRoot":"","sources":["../../src/cmp/ReadmeModel.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAGjB,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IACxD,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IAEtE,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;qBAcW,KAAK,CAAC,IAAI;;;qBAGV,KAAK,CAAC,IAAI;;;;;;;;CAQ9B,CAAC,CAAA;IAEA,IAAA,eAAI,EAAC,UAAU,EAAE,CAAC,MAAW,EAAE,EAAE;QAC/B,IAAA,kBAAO,EAAC,OAAO,MAAM,CAAC,IAAI,8BAA8B,MAAM,CAAC,IAAI;CACtE,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,IAAA,kBAAO,EAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwEO,KAAK,CAAC,IAAI;;;CAG1B,CAAC,CAAA;AAGF,CAAC,CAAC,CAAA;AAMA,kCAAW"}

package/dist/cmp/ReadmeOptions.js

@@ -4,18 +4,43 @@ exports.ReadmeOptions = void 0;
 const jostraca_1 = require("jostraca");
 const ReadmeOptions = (0, jostraca_1.cmp)(function ReadmeOptions(props) {
     const { target } = props;
+    const { model } = props.ctx$;
+    const publishedOptions = (0, jostraca_1.each)(target.options)
+        .filter((option) => option.publish);
+    if (0 === publishedOptions.length) {
+        return;
+    }
     (0, jostraca_1.Content)(`
 
 ## Options
 
+Pass options when creating a client instance:
+
+\`\`\`ts
+const client = new ${model.Name}SDK({
+`);
+    publishedOptions.map((option) => {
+        if ('apikey' === option.name) {
+            (0, jostraca_1.Content)(`  ${option.name}: process.env.${model.NAME}_APIKEY,
+`);
+        }
+        else {
+            (0, jostraca_1.Content)(`  // ${option.name}: ${option.kind === 'string' ? "'...'" : '...'},
+`);
+        }
+    });
+    (0, jostraca_1.Content)(`})
+\`\`\`
+
+| Option | Type | Description |
+| --- | --- | --- |
 `);
-    (0, jostraca_1.each)(target.options)
-        .filter((option) => option.publish)
-        .map((option) => {
-        (0, jostraca_1.Content)(`
-* __${option.name} (${option.kind})__: ${option.short}
+    publishedOptions.map((option) => {
+        (0, jostraca_1.Content)(`| \`${option.name}\` | \`${option.kind}\` | ${option.short} |
 `);
     });
+    (0, jostraca_1.Content)(`
+`);
 });
 exports.ReadmeOptions = ReadmeOptions;
 //# sourceMappingURL=ReadmeOptions.js.map

package/dist/cmp/ReadmeOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeOptions.js","sourceRoot":"","sources":["../../src/cmp/ReadmeOptions.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,MAAM,aAAa,GAAG,IAAA,cAAG,EAAC,SAAS,aAAa,CAAC,KAAU;IACzD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IAExB,IAAA,kBAAO,EAAC;;;;CAIT,CAAC,CAAA;IAEA,IAAA,eAAI,EAAC,MAAM,CAAC,OAAO,CAAC;SACjB,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;SACvC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACnB,IAAA,kBAAO,EAAC;MACR,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,QAAQ,MAAM,CAAC,KAAK;CACpD,CAAC,CAAA;IACE,CAAC,CAAC,CAAA;AAGN,CAAC,CAAC,CAAA;AAKA,sCAAa"}
+{"version":3,"file":"ReadmeOptions.js","sourceRoot":"","sources":["../../src/cmp/ReadmeOptions.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAG7C,MAAM,aAAa,GAAG,IAAA,cAAG,EAAC,SAAS,aAAa,CAAC,KAAU;IACzD,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;IACxB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,MAAM,gBAAgB,GAAG,IAAA,eAAI,EAAC,MAAM,CAAC,OAAO,CAAC;SAC1C,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAE1C,IAAI,CAAC,KAAK,gBAAgB,CAAC,MAAM,EAAE,CAAC;QAClC,OAAM;IACR,CAAC;IAED,IAAA,kBAAO,EAAC;;;;;;;qBAOW,KAAK,CAAC,IAAI;CAC9B,CAAC,CAAA;IAEA,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACnC,IAAI,QAAQ,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YAC7B,IAAA,kBAAO,EAAC,KAAK,MAAM,CAAC,IAAI,iBAAiB,KAAK,CAAC,IAAI;CACxD,CAAC,CAAA;QACE,CAAC;aACI,CAAC;YACJ,IAAA,kBAAO,EAAC,QAAQ,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;CAC/E,CAAC,CAAA;QACE,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,kBAAO,EAAC;;;;;CAKT,CAAC,CAAA;IAEA,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;QACnC,IAAA,kBAAO,EAAC,OAAO,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,IAAI,QAAQ,MAAM,CAAC,KAAK;CACtE,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,IAAA,kBAAO,EAAC;CACT,CAAC,CAAA;AAEF,CAAC,CAAC,CAAA;AAKA,sCAAa"}

package/dist/cmp/ReadmeRef.d.ts

@@ -0,0 +1,2 @@
+declare const ReadmeRef: import("jostraca").Component;
+export { ReadmeRef };