@voxgig/sdkgen 0.5.0 → 0.7.0

package/dist/cmp/Readme.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Readme = void 0;
 const jostraca_1 = require("jostraca");
+const ReadmeIntro_1 = require("./ReadmeIntro");
 const ReadmeInstall_1 = require("./ReadmeInstall");
+const ReadmeQuick_1 = require("./ReadmeQuick");
+const ReadmeModel_1 = require("./ReadmeModel");
 const ReadmeOptions_1 = require("./ReadmeOptions");
 const ReadmeEntity_1 = require("./ReadmeEntity");
 const Readme = (0, jostraca_1.cmp)(function Readme(props) {
@@ -10,9 +13,13 @@ const Readme = (0, jostraca_1.cmp)(function Readme(props) {
     const { model } = props.ctx$;
     (0, jostraca_1.File)({ name: 'README.md' }, () => {
         (0, jostraca_1.Code)(`
-# ${model.Name} ${build.Name} SDK
+# ${model.Name} ${build.title} SDK
 `);
+        // Sections
+        (0, ReadmeIntro_1.ReadmeIntro)({ build });
         (0, ReadmeInstall_1.ReadmeInstall)({ build });
+        (0, ReadmeQuick_1.ReadmeQuick)({ build });
+        (0, ReadmeModel_1.ReadmeModel)({ build });
         (0, ReadmeOptions_1.ReadmeOptions)({ build });
         (0, ReadmeEntity_1.ReadmeEntity)({ build });
     });

package/dist/cmp/Readme.js.map

@@ -1 +1 @@
-{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA0C;AAG1C,mDAA+C;AAC/C,mDAA+C;AAC/C,iDAA6C;AAG7C,MAAM,MAAM,GAAG,IAAA,cAAG,EAAC,SAAS,MAAM,CAAC,KAAU;IAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;IACvB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,eAAI,EAAC;IACL,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI;CAC3B,CAAC,CAAA;QAEE,IAAA,6BAAa,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACxB,IAAA,6BAAa,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACxB,IAAA,2BAAY,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAIA,wBAAM"}
+{"version":3,"file":"Readme.js","sourceRoot":"","sources":["../../src/cmp/Readme.ts"],"names":[],"mappings":";;;AACA,uCAA0C;AAG1C,+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,KAAK,EAAE,GAAG,KAAK,CAAA;IACvB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAA;IAE5B,IAAA,eAAI,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,GAAG,EAAE;QAE/B,IAAA,eAAI,EAAC;IACL,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,KAAK;CAC5B,CAAC,CAAA;QACE,WAAW;QACX,IAAA,yBAAW,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACtB,IAAA,6BAAa,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACxB,IAAA,yBAAW,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACtB,IAAA,yBAAW,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACtB,IAAA,6BAAa,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACxB,IAAA,2BAAY,EAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IACzB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAIA,wBAAM"}

package/dist/cmp/ReadmeInstall.js

@@ -2,48 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReadmeInstall = void 0;
 const jostraca_1 = require("jostraca");
+const utility_1 = require("../utility");
 const ReadmeInstall = (0, jostraca_1.cmp)(function ReadmeInstall(props) {
-    const { build } = props;
+    const { build, ctx$ } = props;
     (0, jostraca_1.Code)(`
 ## Install
 `);
-    (0, jostraca_1.select)(build.name, {
-        js: () => (0, jostraca_1.Code)(`
-\`\`\`
-
-npm install ${build.name}SDK
-
-\`\`\`
-`),
-        python: () => (0, jostraca_1.Code)(`
-\`\`\`
-
-pip install ${build.name}SDK
-
-\`\`\`
-`),
-        java: () => (0, jostraca_1.Code)(`
-\`\`\`
-
-maven install ${build.name}SDK
-
-\`\`\`
-`),
-        go: () => (0, jostraca_1.Code)(`
-\`\`\`
-
-go get ${build.name}SDK
-
-\`\`\`
-`),
-        ruby: () => (0, jostraca_1.Code)(`
-\`\`\`
-
-gem install ${build.name}SDK
-
-\`\`\`
-`)
-    });
+    // Optional
+    const ReadmeInstall_sdk = (0, utility_1.requirePath)(ctx$, `./${build.name}/ReadmeInstall_${build.name}`);
+    if (ReadmeInstall_sdk) {
+        ReadmeInstall_sdk['ReadmeInstall']({ build });
+    }
 });
 exports.ReadmeInstall = ReadmeInstall;
 //# sourceMappingURL=ReadmeInstall.js.map

package/dist/cmp/ReadmeInstall.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReadmeInstall.js","sourceRoot":"","sources":["../../src/cmp/ReadmeInstall.ts"],"names":[],"mappings":";;;AACA,uCAA4C;AAG5C,MAAM,aAAa,GAAG,IAAA,cAAG,EAAC,SAAS,aAAa,CAAC,KAAU;IACzD,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;IAEvB,IAAA,eAAI,EAAC;;CAEN,CAAC,CAAA;IAEA,IAAA,iBAAM,EAAC,KAAK,CAAC,IAAI,EAAE;QACjB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC;;;cAGL,KAAK,CAAC,IAAI;;;CAGvB,CAAC;QAEE,MAAM,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC;;;cAGT,KAAK,CAAC,IAAI;;;CAGvB,CAAC;QAEE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC;;;gBAGL,KAAK,CAAC,IAAI;;;CAGzB,CAAC;QAEE,EAAE,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC;;;SAGV,KAAK,CAAC,IAAI;;;CAGlB,CAAC;QAEE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAA,eAAI,EAAC;;;cAGP,KAAK,CAAC,IAAI;;;CAGvB,CAAC;KAGC,CAAC,CAAA;AAEJ,CAAC,CAAC,CAAA;AAOA,sCAAa"}
+{"version":3,"file":"ReadmeInstall.js","sourceRoot":"","sources":["../../src/cmp/ReadmeInstall.ts"],"names":[],"mappings":";;;AACA,uCAAoC;AAEpC,wCAAwC;AAGxC,MAAM,aAAa,GAAG,IAAA,cAAG,EAAC,SAAS,aAAa,CAAC,KAAU;IACzD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAE7B,IAAA,eAAI,EAAC;;CAEN,CAAC,CAAA;IAEA,WAAW;IACX,MAAM,iBAAiB,GAAG,IAAA,qBAAW,EAAC,IAAI,EAAE,KAAK,KAAK,CAAC,IAAI,kBAAkB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAE1F,IAAI,iBAAiB,EAAE,CAAC;QACtB,iBAAiB,CAAC,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/C,CAAC;AACH,CAAC,CAAC,CAAA;AAOA,sCAAa"}

package/dist/cmp/ReadmeIntro.d.ts

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

package/dist/cmp/ReadmeIntro.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadmeIntro = void 0;
+const jostraca_1 = require("jostraca");
+const ReadmeIntro = (0, jostraca_1.cmp)(function ReadmeIntro(props) {
+    const { ctx$: { model } } = props;
+    (0, jostraca_1.Code)(`
+## Introduction
+
+${model.main.def.desc}
+
+`);
+});
+exports.ReadmeIntro = ReadmeIntro;
+//# sourceMappingURL=ReadmeIntro.js.map

package/dist/cmp/ReadmeIntro.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadmeIntro.js","sourceRoot":"","sources":["../../src/cmp/ReadmeIntro.ts"],"names":[],"mappings":";;;AACA,uCAA4C;AAG5C,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,IAAA,eAAI,EAAC;;;EAGL,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;;CAEpB,CAAC,CAAA;AAIF,CAAC,CAAC,CAAA;AAMA,kCAAW"}

package/dist/cmp/ReadmeModel.d.ts

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

package/dist/cmp/ReadmeModel.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadmeModel = void 0;
+const jostraca_1 = require("jostraca");
+const ReadmeModel = (0, jostraca_1.cmp)(function ReadmeModel(props) {
+    const { ctx$: { model } } = props;
+    (0, jostraca_1.Code)(`
+## Entity Model
+
+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.
+
+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.
+
+
+### SDK Methods
+
+* \`make(options)\`: Create a new client instance. 
+
+
+### Client Methods
+
+* \`[Entity]()\`: Create a new business entity 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.
+
+`);
+});
+exports.ReadmeModel = ReadmeModel;
+//# sourceMappingURL=ReadmeModel.js.map

package/dist/cmp/ReadmeModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadmeModel.js","sourceRoot":"","sources":["../../src/cmp/ReadmeModel.ts"],"names":[],"mappings":";;;AACA,uCAAoC;AAGpC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,CAAA;IAEjC,IAAA,eAAI,EAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+BN,CAAC,CAAA;AAIF,CAAC,CAAC,CAAA;AAMA,kCAAW"}

package/dist/cmp/ReadmeQuick.d.ts

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

package/dist/cmp/ReadmeQuick.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadmeQuick = void 0;
+const jostraca_1 = require("jostraca");
+const utility_1 = require("../utility");
+const ReadmeQuick = (0, jostraca_1.cmp)(function ReadmeQuick(props) {
+    const { build, ctx$ } = props;
+    (0, jostraca_1.Code)(`
+## Quick Start
+
+`);
+    const ReadmeQuick_sdk = (0, utility_1.requirePath)(ctx$, `./${build.name}/ReadmeQuick_${build.name}`);
+    if (ReadmeQuick_sdk) {
+        ReadmeQuick_sdk['ReadmeQuick']({ build });
+    }
+});
+exports.ReadmeQuick = ReadmeQuick;
+//# sourceMappingURL=ReadmeQuick.js.map

package/dist/cmp/ReadmeQuick.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReadmeQuick.js","sourceRoot":"","sources":["../../src/cmp/ReadmeQuick.ts"],"names":[],"mappings":";;;AACA,uCAAoC;AAEpC,wCAAwC;AAGxC,MAAM,WAAW,GAAG,IAAA,cAAG,EAAC,SAAS,WAAW,CAAC,KAAU;IACrD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAA;IAE7B,IAAA,eAAI,EAAC;;;CAGN,CAAC,CAAA;IAGA,MAAM,eAAe,GAAG,IAAA,qBAAW,EAAC,IAAI,EAAE,KAAK,KAAK,CAAC,IAAI,gBAAgB,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IAEtF,IAAI,eAAe,EAAE,CAAC;QACpB,eAAe,CAAC,aAAa,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;AACH,CAAC,CAAC,CAAA;AAMA,kCAAW"}

package/dist/sdkgen.d.ts

@@ -13,7 +13,7 @@ type SdkGenOptions = {
         folder: string;
         entity: any;
     };
-    meta: {
+    meta?: {
         name: string;
     };
 };

package/dist/sdkgen.js

@@ -76,6 +76,7 @@ function SdkGen(opts) {
     };
 }
 SdkGen.makeBuild = async function (root, opts) {
+    console.log('SdkGen.makeBuild', opts);
     const sdkgen = SdkGen(opts);
     const apidef = (0, apidef_1.ApiDef)();
     const spec = {
@@ -88,6 +89,7 @@ SdkGen.makeBuild = async function (root, opts) {
     await apidef.watch(spec);
     return async function build(model, build) {
         // TODO: voxgig model needs to handle errors from here
+        console.log('SDK GENERATE');
         return sdkgen.generate({ model, build, root });
     };
 };

package/dist/sdkgen.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdkgen.js","sourceRoot":"","sources":["../src/sdkgen.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;AA8IlD,wBAAM;AA5IR,4CAA6B;AAG7B,yDAA0C;AAE1C,2CAAuC;AAGvC,qCAAiC;AA4H/B,qFA5HO,WAAI,OA4HP;AA3HN,yCAAqC;AA4HnC,uFA5HO,eAAM,OA4HP;AA3HR,yCAAqC;AA4HnC,uFA5HO,eAAM,OA4HP;AA3HR,uDAAmD;AA4HjD,8FA5HO,6BAAa,OA4HP;AA3Hf,uDAAmD;AA4HjD,8FA5HO,6BAAa,OA4HP;AA3Hf,qDAAiD;AA4H/C,6FA5HO,2BAAY,OA4HP;AA1Hd,uDAAkD;AAiBlD,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAA;AA2GjC,4BAAQ;AAxGV,SAAS,MAAM,CAAC,IAAmB;IACjC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;IACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAA;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,SAAS,CAAA;IACjC,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAA;IAG3B,KAAK,UAAU,QAAQ,CAAC,IAAS;QAC/B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QAE5B;;;;UAIE;QAEF,+BAA+B;QAE/B,MAAM,IAAI,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,CAAA;QAE3C,IAAI,CAAC;YACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,GAAQ,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;YAClC,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAGD,KAAK,UAAU,OAAO,CAAC,IAAS,EAAE,GAAQ;QACxC,OAAO,MAAM,IAAA,gCAAc,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IACxC,CAAC;IAGD,OAAO;QACL,QAAQ;QAER,aAAa;QAEb,8BAA8B;KAC/B,CAAA;AAEH,CAAC;AAGD,MAAM,CAAC,SAAS,GAAG,KAAK,WAAU,IAAS,EAAE,IAAmB;IAC9D,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAE3B,MAAM,MAAM,GAAG,IAAA,eAAM,GAAE,CAAA;IAEvB,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;QACnE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;QACrB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KACnD,CAAA;IAED,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAExB,OAAO,KAAK,UAAU,KAAK,CAAC,KAAU,EAAE,KAAU;QAChD,sDAAsD;QACtD,OAAO,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAChD,CAAC,CAAA;AACH,CAAC,CAAA;AAYY,QAAA,GAAG,GAAuC,cAAc,CAAC,GAAG,CAAA;AAC5D,QAAA,KAAK,GAAoD,cAAc,CAAC,KAAK,CAAA;AAC7E,QAAA,IAAI,GAAwC,cAAc,CAAC,IAAI,CAAA;AAC/D,QAAA,OAAO,GAAsC,cAAc,CAAC,OAAO,CAAA;AACnE,QAAA,QAAQ,GAAsC,cAAc,CAAC,QAAQ,CAAA;AACrE,QAAA,QAAQ,GAAsC,cAAc,CAAC,QAAQ,CAAA;AACrE,QAAA,MAAM,GAAqD,cAAc,CAAC,MAAM,CAAA;AAChF,QAAA,IAAI,GAA4B,cAAc,CAAC,IAAI,CAAA;AACnD,QAAA,IAAI,GAA4B,cAAc,CAAC,IAAI,CAAA;AACnD,QAAA,GAAG,GAAgD,cAAc,CAAC,GAAG,CAAA;AACrE,QAAA,IAAI,GAAgD,cAAc,CAAC,IAAI,CAAA;AAEvE,QAAA,OAAO,GAAc,cAAc,CAAC,OAAO,CAAA;AAC3C,QAAA,MAAM,GAAc,cAAc,CAAC,MAAM,CAAA;AACzC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA;AACrC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA;AACrC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA"}
+{"version":3,"file":"sdkgen.js","sourceRoot":"","sources":["../src/sdkgen.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;;;;;;;;;;;;;;;;;;;;;;;AAiJlD,wBAAM;AA/IR,4CAA6B;AAG7B,yDAA0C;AAE1C,2CAAuC;AAGvC,qCAAiC;AA+H/B,qFA/HO,WAAI,OA+HP;AA9HN,yCAAqC;AA+HnC,uFA/HO,eAAM,OA+HP;AA9HR,yCAAqC;AA+HnC,uFA/HO,eAAM,OA+HP;AA9HR,uDAAmD;AA+HjD,8FA/HO,6BAAa,OA+HP;AA9Hf,uDAAmD;AA+HjD,8FA/HO,6BAAa,OA+HP;AA9Hf,qDAAiD;AA+H/C,6FA/HO,2BAAY,OA+HP;AA7Hd,uDAAkD;AAiBlD,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,CAAA;AA8GjC,4BAAQ;AA3GV,SAAS,MAAM,CAAC,IAAmB;IACjC,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,CAAA;IACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,GAAG,CAAA;IACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,SAAS,CAAA;IACjC,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAA;IAG3B,KAAK,UAAU,QAAQ,CAAC,IAAS;QAC/B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;QAE5B;;;;UAIE;QAEF,+BAA+B;QAE/B,MAAM,IAAI,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,EAAE,CAAA;QAE3C,IAAI,CAAC;YACH,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAChD,CAAC;QACD,OAAO,GAAQ,EAAE,CAAC;YAChB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAA;YAClC,MAAM,GAAG,CAAA;QACX,CAAC;IACH,CAAC;IAGD,KAAK,UAAU,OAAO,CAAC,IAAS,EAAE,GAAQ;QACxC,OAAO,MAAM,IAAA,gCAAc,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;IACxC,CAAC;IAGD,OAAO;QACL,QAAQ;QAER,aAAa;QAEb,8BAA8B;KAC/B,CAAA;AAEH,CAAC;AAGD,MAAM,CAAC,SAAS,GAAG,KAAK,WAAU,IAAS,EAAE,IAAmB;IAC9D,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;IAErC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;IAE3B,MAAM,MAAM,GAAG,IAAA,eAAM,GAAE,CAAA;IAEvB,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;QACnE,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;QACrB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;KACnD,CAAA;IAED,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAExB,OAAO,KAAK,UAAU,KAAK,CAAC,KAAU,EAAE,KAAU;QAChD,sDAAsD;QACtD,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC3B,OAAO,MAAM,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IAChD,CAAC,CAAA;AACH,CAAC,CAAA;AAYY,QAAA,GAAG,GAAuC,cAAc,CAAC,GAAG,CAAA;AAC5D,QAAA,KAAK,GAAoD,cAAc,CAAC,KAAK,CAAA;AAC7E,QAAA,IAAI,GAAwC,cAAc,CAAC,IAAI,CAAA;AAC/D,QAAA,OAAO,GAAsC,cAAc,CAAC,OAAO,CAAA;AACnE,QAAA,QAAQ,GAAsC,cAAc,CAAC,QAAQ,CAAA;AACrE,QAAA,QAAQ,GAAsC,cAAc,CAAC,QAAQ,CAAA;AACrE,QAAA,MAAM,GAAqD,cAAc,CAAC,MAAM,CAAA;AAChF,QAAA,IAAI,GAA4B,cAAc,CAAC,IAAI,CAAA;AACnD,QAAA,IAAI,GAA4B,cAAc,CAAC,IAAI,CAAA;AACnD,QAAA,GAAG,GAAgD,cAAc,CAAC,GAAG,CAAA;AACrE,QAAA,IAAI,GAAgD,cAAc,CAAC,IAAI,CAAA;AAEvE,QAAA,OAAO,GAAc,cAAc,CAAC,OAAO,CAAA;AAC3C,QAAA,MAAM,GAAc,cAAc,CAAC,MAAM,CAAA;AACzC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA;AACrC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA;AACrC,QAAA,IAAI,GAAc,cAAc,CAAC,IAAI,CAAA"}

package/dist/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["../src/prepare-openapi.ts","../src/sdkgen.ts","../src/utility.ts","../src/cmp/entity.ts","../src/cmp/main.ts","../src/cmp/readme.ts","../src/cmp/readmeentity.ts","../src/cmp/readmeinstall.ts","../src/cmp/readmeintro.ts","../src/cmp/readmemodel.ts","../src/cmp/readmeoptions.ts","../src/cmp/readmequick.ts"],"version":"5.6.2"}

package/dist/utility.d.ts

@@ -1,2 +1,5 @@
 declare const resolvePath: (ctx$: any, path: string) => any;
-export { resolvePath };
+declare const requirePath: (ctx$: any, path: string, flags?: {
+    ignore?: boolean;
+}) => any;
+export { resolvePath, requirePath, };

package/dist/utility.js

@@ -3,11 +3,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePath = void 0;
+exports.requirePath = exports.resolvePath = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const resolvePath = (ctx$, path) => {
     const fullpath = node_path_1.default.join(ctx$.folder, '..', 'dist', path);
     return fullpath;
 };
 exports.resolvePath = resolvePath;
+const requirePath = (ctx$, path, flags) => {
+    const fullpath = resolvePath(ctx$, path);
+    const ignore = null == flags?.ignore ? true : flags.ignore;
+    try {
+        return require(fullpath);
+    }
+    catch (err) {
+        if (!ignore) {
+            throw err;
+        }
+        console.warn('MISSING: ', path);
+    }
+};
+exports.requirePath = requirePath;
 //# sourceMappingURL=utility.js.map

package/dist/utility.js.map

@@ -1 +1 @@
-{"version":3,"file":"utility.js","sourceRoot":"","sources":["../src/utility.ts"],"names":[],"mappings":";;;;;;AACA,0DAA4B;AAG5B,MAAM,WAAW,GAAG,CAAC,IAAS,EAAE,IAAY,EAAO,EAAE;IACnD,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IAC3D,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAIC,kCAAW"}
+{"version":3,"file":"utility.js","sourceRoot":"","sources":["../src/utility.ts"],"names":[],"mappings":";;;;;;AACA,0DAA4B;AAG5B,MAAM,WAAW,GAAG,CAAC,IAAS,EAAE,IAAY,EAAO,EAAE;IACnD,MAAM,QAAQ,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;IAC3D,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAqBC,kCAAW;AAlBb,MAAM,WAAW,GAAG,CAAC,IAAS,EAAE,IAAY,EAAE,KAA4B,EAAO,EAAE;IACjF,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,IAAI,IAAI,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAA;IAE1D,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,QAAQ,CAAC,CAAA;IAC1B,CAAC;IACD,OAAO,GAAQ,EAAE,CAAC;QAChB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,CAAA;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IACjC,CAAC;AACH,CAAC,CAAA;AAMC,kCAAW"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxgig/sdkgen",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "main": "dist/sdkgen.js",
   "type": "commonjs",
   "types": "dist/sdkgen.d.ts",
@@ -40,11 +40,11 @@
     "esbuild": "^0.23.1",
     "json-schema-to-ts": "^3.1.1",
     "memfs": "^4.11.1",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   },
   "dependencies": {
-    "@redocly/openapi-core": "^1.23.0",
-    "@voxgig/apidef": "^0.0.6",
-    "jostraca": "^0.4.0"
+    "@redocly/openapi-core": "^1.25.0",
+    "@voxgig/apidef": "^0.0.7",
+    "jostraca": "^0.5.0"
   }
 }

package/src/cmp/Readme.ts

@@ -2,7 +2,10 @@
 import { cmp, File, Code } from 'jostraca'
 
 
+import { ReadmeIntro } from './ReadmeIntro'
 import { ReadmeInstall } from './ReadmeInstall'
+import { ReadmeQuick } from './ReadmeQuick'
+import { ReadmeModel } from './ReadmeModel'
 import { ReadmeOptions } from './ReadmeOptions'
 import { ReadmeEntity } from './ReadmeEntity'
 
@@ -14,10 +17,13 @@ const Readme = cmp(function Readme(props: any) {
   File({ name: 'README.md' }, () => {
 
     Code(`
-# ${model.Name} ${build.Name} SDK
+# ${model.Name} ${build.title} SDK
 `)
-
+    // Sections
+    ReadmeIntro({ build })
     ReadmeInstall({ build })
+    ReadmeQuick({ build })
+    ReadmeModel({ build })
     ReadmeOptions({ build })
     ReadmeEntity({ build })
   })

package/src/cmp/ReadmeInstall.ts

@@ -1,58 +1,22 @@
 
-import { cmp, select, Code } from 'jostraca'
+import { cmp, Code } from 'jostraca'
+
+import { requirePath } from '../utility'
 
 
 const ReadmeInstall = cmp(function ReadmeInstall(props: any) {
-  const { build } = props
+  const { build, ctx$ } = props
 
   Code(`
 ## Install
 `)
 
-  select(build.name, {
-    js: () => Code(`
-\`\`\`
-
-npm install ${build.name}SDK
-
-\`\`\`
-`),
-
-    python: () => Code(`
-\`\`\`
-
-pip install ${build.name}SDK
-
-\`\`\`
-`),
-
-    java: () => Code(`
-\`\`\`
-
-maven install ${build.name}SDK
-
-\`\`\`
-`),
-
-    go: () => Code(`
-\`\`\`
-
-go get ${build.name}SDK
-
-\`\`\`
-`),
-
-    ruby: () => Code(`
-\`\`\`
-
-gem install ${build.name}SDK
-
-\`\`\`
-`)
-
-
-  })
+  // Optional
+  const ReadmeInstall_sdk = requirePath(ctx$, `./${build.name}/ReadmeInstall_${build.name}`)
 
+  if (ReadmeInstall_sdk) {
+    ReadmeInstall_sdk['ReadmeInstall']({ build })
+  }
 })
 
 

package/src/cmp/ReadmeIntro.ts

@@ -0,0 +1,24 @@
+
+import { cmp, select, Code } from 'jostraca'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { ctx$: { model } } = props
+
+  Code(`
+## Introduction
+
+${model.main.def.desc}
+
+`)
+
+
+
+})
+
+
+
+
+export {
+  ReadmeIntro
+}

package/src/cmp/ReadmeIntro.ts~

@@ -0,0 +1,25 @@
+
+import { cmp, select, Code } from 'jostraca'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { build, ctx$ } = props
+  const { model } = ctx$
+
+  Code(`
+## Introduction
+
+${model.main.def.desc}
+
+`)
+
+
+
+})
+
+
+
+
+export {
+  ReadmeIntro
+}

package/src/cmp/ReadmeModel.ts

@@ -0,0 +1,50 @@
+
+import { cmp, Code } from 'jostraca'
+
+
+const ReadmeModel = cmp(function ReadmeModel(props: any) {
+  const { ctx$: { model } } = props
+
+  Code(`
+## Entity Model
+
+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.
+
+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.
+
+
+### SDK Methods
+
+* \`make(options)\`: Create a new client instance. 
+
+
+### Client Methods
+
+* \`[Entity]()\`: Create a new business entity 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.
+
+`)
+
+
+
+})
+
+
+
+
+export {
+  ReadmeModel
+}

package/src/cmp/ReadmeModel.ts~

@@ -0,0 +1,24 @@
+
+import { cmp, select, Code } from 'jostraca'
+
+
+const ReadmeIntro = cmp(function ReadmeIntro(props: any) {
+  const { ctx$: { model } } = props
+
+  Code(`
+## Introduction
+
+${model.main.def.desc}
+
+`)
+
+
+
+})
+
+
+
+
+export {
+  ReadmeIntro
+}

package/src/cmp/ReadmeQuick.ts

@@ -0,0 +1,28 @@
+
+import { cmp, Code } from 'jostraca'
+
+import { requirePath } from '../utility'
+
+
+const ReadmeQuick = cmp(function ReadmeQuick(props: any) {
+  const { build, ctx$ } = props
+
+  Code(`
+## Quick Start
+
+`)
+
+
+  const ReadmeQuick_sdk = requirePath(ctx$, `./${build.name}/ReadmeQuick_${build.name}`)
+
+  if (ReadmeQuick_sdk) {
+    ReadmeQuick_sdk['ReadmeQuick']({ build })
+  }
+})
+
+
+
+
+export {
+  ReadmeQuick
+}

package/src/sdkgen.ts

@@ -26,7 +26,7 @@ type SdkGenOptions = {
     folder: string
     entity: any
   }
-  meta: {
+  meta?: {
     name: string
   }
 }
@@ -82,6 +82,8 @@ function SdkGen(opts: SdkGenOptions) {
 
 
 SdkGen.makeBuild = async function(root: any, opts: SdkGenOptions) {
+  console.log('SdkGen.makeBuild', opts)
+
   const sdkgen = SdkGen(opts)
 
   const apidef = ApiDef()
@@ -98,6 +100,7 @@ SdkGen.makeBuild = async function(root: any, opts: SdkGenOptions) {
 
   return async function build(model: any, build: any) {
     // TODO: voxgig model needs to handle errors from here
+    console.log('SDK GENERATE')
     return sdkgen.generate({ model, build, root })
   }
 }

package/src/utility.ts

@@ -8,6 +8,24 @@ const resolvePath = (ctx$: any, path: string): any => {
 }
 
 
+const requirePath = (ctx$: any, path: string, flags?: { ignore?: boolean }): any => {
+  const fullpath = resolvePath(ctx$, path)
+  const ignore = null == flags?.ignore ? true : flags.ignore
+
+  try {
+    return require(fullpath)
+  }
+  catch (err: any) {
+    if (!ignore) {
+      throw err
+    }
+    console.warn('MISSING: ', path)
+  }
+}
+
+
+
 export {
-  resolvePath
+  resolvePath,
+  requirePath,
 }