@voxgig/sdkgen 0.35.2 → 0.37.0

package/dist/cmp/ReadmeModel.js

@@ -3,116 +3,80 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeModel = void 0;
 const jostraca_1 = require("jostraca");
 const types_1 = require("../types");
+const utility_1 = require("../utility");
 const ReadmeModel = (0, jostraca_1.cmp)(function ReadmeModel(props) {
-    const { ctx$: { model } } = props;
+    const { target, ctx$ } = props;
+    const { model } = ctx$;
     const entity = (0, types_1.getModelPath)(model, `main.${types_1.KIT}.entity`);
-    const entityList = Object.values(entity).filter((e) => e.publish);
+    const entityList = (0, jostraca_1.each)(entity).filter((e) => e.active !== false);
     (0, jostraca_1.Content)(`
-## SDK Structure
+## Reference
 
-This SDK uses an entity-oriented interface rather than exposing API
-endpoint paths directly. Business logic maps directly to business
-entities in your code.
-
-
-### Client
-
-Create a client instance using the constructor or the static \`test\` method:
-
-\`\`\`ts
-// Production client
-const client = new ${model.Name}SDK({ apikey: '...' })
+`);
+    // Delegate to target-specific reference summary
+    const ReadmeModel_sdk = (0, utility_1.requirePath)(ctx$, `./cmp/${target.name}/ReadmeModel_${target.name}`, { ignore: true });
+    if (ReadmeModel_sdk) {
+        ReadmeModel_sdk['ReadmeModel']({ target });
+    }
+    else {
+        // Fallback: generic reference summary
+        ReadmeModelGeneric({ target, model, entityList });
+    }
+});
+exports.ReadmeModel = ReadmeModel;
+const ReadmeModelGeneric = (0, jostraca_1.cmp)(function ReadmeModelGeneric(props) {
+    const { target, model, entityList } = props;
+    (0, jostraca_1.Content)(`### ${model.Name}SDK
 
-// Test client with mock features
-const testClient = ${model.Name}SDK.test()
-\`\`\`
+#### Constructor
 
+| Option | Type | Description |
+| --- | --- | --- |
+| \`apikey\` | \`string\` | API key for authentication. |
+| \`base\` | \`string\` | Base URL of the API server. |
+| \`prefix\` | \`string\` | URL path prefix prepended to all requests. |
+| \`suffix\` | \`string\` | URL path suffix appended to all requests. |
+| \`feature\` | \`object\` | Feature activation flags. |
+| \`extend\` | \`array\` | Additional Feature instances to load. |
 
-### Client Methods
+#### Methods
 
-| Method | Description |
-| --- | --- |
+| Method | Returns | Description |
+| --- | --- | --- |
 `);
-    (0, jostraca_1.each)(entityList, (entity) => {
-        (0, jostraca_1.Content)(`| \`${entity.Name}(data?)\` | Create a new \`${entity.Name}\` entity instance. |
+    (0, jostraca_1.each)(entityList, (ent) => {
+        (0, jostraca_1.Content)(`| \`${ent.Name}(data?)\` | \`${ent.Name}Entity\` | Create a ${ent.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. |
+    (0, jostraca_1.Content)(`| \`options()\` | \`object\` | Deep copy of current SDK options. |
+| \`utility()\` | \`Utility\` | Copy of the SDK utility object. |
+| \`prepare(fetchargs?)\` | \`FetchDef\` | Build an HTTP request definition without sending it. |
+| \`direct(fetchargs?)\` | \`DirectResult\` | Build and send an HTTP request. |
+| \`tester(testopts?, sdkopts?)\` | \`${model.Name}SDK\` | Create a test-mode client instance. |
 
+#### Static methods
 
-### Entity Methods
+| Method | Returns | Description |
+| --- | --- | --- |
+| \`${model.Name}SDK.test(testopts?, sdkopts?)\` | \`${model.Name}SDK\` | Create a test-mode client. |
 
-Each entity instance provides the following methods, where available:
+### Entity interface
+
+All entities share the same interface.
 
 | 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. |
+| \`load(reqmatch?, ctrl?)\` | Load a single entity by match criteria. |
+| \`list(reqmatch?, ctrl?)\` | List entities matching the criteria. |
+| \`create(reqdata?, ctrl?)\` | Create a new entity. |
+| \`update(reqdata?, ctrl?)\` | Update an existing entity. |
+| \`remove(reqmatch?, ctrl?)\` | Remove an entity. |
+| \`data(data?)\` | Get or set entity data. |
+| \`match(match?)\` | Get or set entity match criteria. |
+| \`make()\` | Create a new instance with the same options. |
+| \`client()\` | Return the parent SDK client. |
 | \`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()
-\`\`\`
-
 `);
 });
-exports.ReadmeModel = ReadmeModel;
 //# sourceMappingURL=ReadmeModel.js.map

package/dist/cmp/ReadmeModel.js.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"ReadmeModel.js","sourceRoot":"","sources":["../../src/cmp/ReadmeModel.ts"],"names":[],"mappings":";;;AACA,uCAA6C;AAE7C,oCAGiB;AAEjB,wCAAwC;AAGxC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAC9B,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAA;IAEtB,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,KAAK,EAAE,QAAQ,WAAG,SAAS,CAAC,CAAA;IACxD,MAAM,UAAU,GAAG,IAAA,eAAI,EAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,KAAK,CAAC,CAAA;IAEtE,IAAA,kBAAO,EAAC;;;CAGT,CAAC,CAAA;IAEA,gDAAgD;IAChD,MAAM,eAAe,GACnB,IAAA,qBAAW,EAAC,IAAI,EAAE,SAAS,MAAM,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAExF,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,CAAC;SACI,CAAC;QACJ,sCAAsC;QACtC,kBAAkB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAA;IACnD,CAAC;AACH,CAAC,CAAC,CAAA;AAkEA,kCAAW;AA/Db,MAAM,kBAAkB,GAAG,IAAA,cAAG,EAAC,SAAS,kBAAkB,CAAC,KAAU;IACnE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,KAAK,CAAA;IAE3C,IAAA,kBAAO,EAAC,OAAO,KAAK,CAAC,IAAI;;;;;;;;;;;;;;;;;CAiB1B,CAAC,CAAA;IAEA,IAAA,eAAI,EAAC,UAAU,EAAE,CAAC,GAAQ,EAAE,EAAE;QAC5B,IAAA,kBAAO,EAAC,OAAO,GAAG,CAAC,IAAI,iBAAiB,GAAG,CAAC,IAAI,uBAAuB,GAAG,CAAC,IAAI;CAClF,CAAC,CAAA;IACA,CAAC,CAAC,CAAA;IAEF,IAAA,kBAAO,EAAC;;;;wCAI8B,KAAK,CAAC,IAAI;;;;;;MAM5C,KAAK,CAAC,IAAI,uCAAuC,KAAK,CAAC,IAAI;;;;;;;;;;;;;;;;;;;CAmBhE,CAAC,CAAA;AACF,CAAC,CAAC,CAAA"}

package/dist/cmp/ReadmeOptions.js

@@ -5,6 +5,7 @@ const jostraca_1 = require("jostraca");
 const ReadmeOptions = (0, jostraca_1.cmp)(function ReadmeOptions(props) {
     const { target } = props;
     const { model } = props.ctx$;
+    const isGo = target.name === 'go';
     const publishedOptions = (0, jostraca_1.each)(target.options)
         .filter((option) => option.publish);
     if (0 === publishedOptions.length) {
@@ -16,23 +17,46 @@ const ReadmeOptions = (0, jostraca_1.cmp)(function ReadmeOptions(props) {
 
 Pass options when creating a client instance:
 
-\`\`\`ts
+`);
+    if (isGo) {
+        (0, jostraca_1.Content)(`\`\`\`go
+client := sdk.New${model.const.Name}SDK(map[string]any{
+`);
+        publishedOptions.map((option) => {
+            if ('apikey' === option.name) {
+                (0, jostraca_1.Content)(`    "${option.name}": os.Getenv("${model.NAME}_APIKEY"),
+`);
+            }
+            else {
+                (0, jostraca_1.Content)(`    // "${option.name}": ${option.kind === 'string' ? '"..."' : '...'},
+`);
+            }
+        });
+        (0, jostraca_1.Content)(`})
+\`\`\`
+
+`);
+    }
+    else {
+        (0, jostraca_1.Content)(`\`\`\`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,
+        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' ? "'...'" : '...'},
+            }
+            else {
+                (0, jostraca_1.Content)(`  // ${option.name}: ${option.kind === 'string' ? "'...'" : '...'},
 `);
-        }
-    });
-    (0, jostraca_1.Content)(`})
+            }
+        });
+        (0, jostraca_1.Content)(`})
 \`\`\`
 
-| Option | Type | Description |
+`);
+    }
+    (0, jostraca_1.Content)(`| Option | Type | Description |
 | --- | --- | --- |
 `);
     publishedOptions.map((option) => {

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;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"}
+{"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,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,IAAI,CAAA;IAEjC,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;;;;;;CAMT,CAAC,CAAA;IAEA,IAAI,IAAI,EAAE,CAAC;QACT,IAAA,kBAAO,EAAC;mBACO,KAAK,CAAC,KAAK,CAAC,IAAI;CAClC,CAAC,CAAA;QAEE,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;YACnC,IAAI,QAAQ,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC,QAAQ,MAAM,CAAC,IAAI,iBAAiB,KAAK,CAAC,IAAI;CAC7D,CAAC,CAAA;YACI,CAAC;iBACI,CAAC;gBACJ,IAAA,kBAAO,EAAC,WAAW,MAAM,CAAC,IAAI,MAAM,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;CACrF,CAAC,CAAA;YACI,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;SACI,CAAC;QACJ,IAAA,kBAAO,EAAC;qBACS,KAAK,CAAC,IAAI;CAC9B,CAAC,CAAA;QAEE,gBAAgB,CAAC,GAAG,CAAC,CAAC,MAAW,EAAE,EAAE;YACnC,IAAI,QAAQ,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC7B,IAAA,kBAAO,EAAC,KAAK,MAAM,CAAC,IAAI,iBAAiB,KAAK,CAAC,IAAI;CAC1D,CAAC,CAAA;YACI,CAAC;iBACI,CAAC;gBACJ,IAAA,kBAAO,EAAC,QAAQ,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;CACjF,CAAC,CAAA;YACI,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAA,kBAAO,EAAC;;;CAGX,CAAC,CAAA;IACA,CAAC;IAED,IAAA,kBAAO,EAAC;;CAET,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/ReadmeQuick.js

@@ -6,7 +6,10 @@ const utility_1 = require("../utility");
 const ReadmeQuick = (0, jostraca_1.cmp)(function ReadmeQuick(props) {
     const { target, ctx$ } = props;
     (0, jostraca_1.Content)(`
-## Quick Start
+## Tutorial: your first API call
+
+This tutorial walks through creating a client, listing entities, and
+loading a specific record.
 
 `);
     const ReadmeQuick_sdk = (0, utility_1.requirePath)(ctx$, `./cmp/${target.name}/ReadmeQuick_${target.name}`, { ignore: true });

package/dist/cmp/ReadmeQuick.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeQuick.js","sourceRoot":"","sources":["../../src/cmp/ReadmeQuick.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAEvC,wCAAwC;AAGxC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAE9B,IAAA,kBAAO,EAAC;;;CAGT,CAAC,CAAA;IAEA,MAAM,eAAe,GACnB,IAAA,qBAAW,EAAC,IAAI,EAAE,SAAS,MAAM,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAExF,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAC,CAAA;AAMA,kCAAW"}
+{"version":3,"file":"ReadmeQuick.js","sourceRoot":"","sources":["../../src/cmp/ReadmeQuick.ts"],"names":[],"mappings":";;;AACA,uCAAuC;AAEvC,wCAAwC;AAGxC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAE9B,IAAA,kBAAO,EAAC;;;;;;CAMT,CAAC,CAAA;IAEA,MAAM,eAAe,GACnB,IAAA,qBAAW,EAAC,IAAI,EAAE,SAAS,MAAM,CAAC,IAAI,gBAAgB,MAAM,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAExF,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC,CAAC,CAAA;AAMA,kCAAW"}