@voxgig/apidef 2.4.1 → 3.1.0

package/dist/types.d.ts

@@ -1,7 +1,9 @@
 import * as Fs from 'node:fs';
 import { Pino, prettyPino } from '@voxgig/util';
+declare const KIT = "kit";
 type FsUtil = typeof Fs;
 type Log = ReturnType<typeof prettyPino>;
+type TypeName = 'String' | 'Number' | 'Integer' | 'Boolean' | 'Null' | 'Array' | 'Object' | 'Any';
 type ApiDefOptions = {
     def?: string;
     fs?: any;
@@ -11,6 +13,9 @@ type ApiDefOptions = {
     meta?: Record<string, any>;
     outprefix?: string;
     strategy?: string;
+    why?: {
+        show?: boolean;
+    };
 };
 declare const ControlShape: {
     <V>(root?: V | undefined, ctx?: import("gubu").Context): V & {
@@ -301,7 +306,7 @@ declare const ModelShape: {
         name: string;
         def: string;
         main: {
-            sdk: {};
+            kit: {};
             def: {};
             api: {
                 guide: {};
@@ -313,7 +318,7 @@ declare const ModelShape: {
         name: StringConstructor;
         def: StringConstructor;
         main: {
-            sdk: {};
+            kit: {};
             def: {};
             api: {
                 guide: {};
@@ -363,7 +368,7 @@ declare const ModelShape: {
         name: StringConstructor;
         def: StringConstructor;
         main: {
-            sdk: {};
+            kit: {};
             def: {};
             api: {
                 guide: {};
@@ -399,7 +404,7 @@ declare const OpenModelShape: {
             name: string;
             def: string;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -411,7 +416,7 @@ declare const OpenModelShape: {
             name: StringConstructor;
             def: StringConstructor;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -461,7 +466,7 @@ declare const OpenModelShape: {
             name: StringConstructor;
             def: StringConstructor;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -520,7 +525,7 @@ declare const OpenModelShape: {
             name: string;
             def: string;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -532,7 +537,7 @@ declare const OpenModelShape: {
             name: StringConstructor;
             def: StringConstructor;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -582,7 +587,7 @@ declare const OpenModelShape: {
             name: StringConstructor;
             def: StringConstructor;
             main: {
-                sdk: {};
+                kit: {};
                 def: {};
                 api: {
                     guide: {};
@@ -983,22 +988,118 @@ declare const OpenBuildShape: {
 type Build = ReturnType<typeof BuildShape>;
 type ApiModel = {
     main: {
-        api: {
+        kit: {
+            info: Record<string, any>;
             entity: Record<string, any>;
+            flow: Record<string, any>;
         };
-        def: Record<string, any>;
     };
 };
+type KitModel = {
+    info: Record<string, any>;
+    entity: Record<string, any>;
+    flow: Record<string, any>;
+};
 type ApiDefResult = {
     ok: boolean;
     start: number;
     end: number;
     steps: string[];
-    ctrl: Control;
+    err?: any;
+    ctrl?: Control;
     guide?: any;
     apimodel?: any;
     ctx?: any;
     jres?: any;
 };
-export { OpenControlShape, OpenModelShape, OpenBuildShape, };
-export type { Log, FsUtil, ApiDefOptions, ApiDefResult, Control, Model, Build, ApiModel, };
+type Metrics = {
+    count: {
+        path: number;
+        method: number;
+        origcmprefs: Record<string, number>;
+        cmp: number;
+        tag: number;
+        entity: number;
+    };
+    found: {
+        cmp: Record<string, any>;
+        tag: Record<string, any>;
+    };
+};
+type ApiDefContext = {
+    fs: any;
+    log: any;
+    spec: any;
+    opts: any;
+    util: any;
+    defpath: string;
+    model: any;
+    apimodel: any;
+    guide: any;
+    def: any;
+    note: any;
+    warn: any;
+    metrics: Metrics;
+    work: Record<string, any>;
+};
+type Warner = {
+    history: ({
+        point: string;
+        when: number;
+    } & Record<string, any>)[];
+    point: string;
+} & ((details: Record<string, any>) => void);
+type MethodName = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | '';
+type Guide = {
+    metrics: GuideMetrics;
+    entity: Record<string, GuideEntity>;
+    control: GuideControl;
+};
+type GuideControl = {};
+type GuideMetrics = {
+    count: {
+        path: number;
+        method: number;
+        entity: number;
+        tag: number;
+        cmp: number;
+        origcmprefs: Record<string, number>;
+    };
+    found: {
+        tag: Record<string, string>;
+        cmp: Record<string, string>;
+    };
+};
+type GuideEntity = {
+    name: string;
+    orig: string;
+    path: Record<string, GuidePath>;
+};
+type GuidePath = {
+    why_path: string[];
+    action: Record<string, GuidePathAction>;
+    rename: {
+        param: Record<string, GuideRenameParam>;
+    };
+    op: Record<string, GuidePathOp>;
+};
+type GuidePathAction = {
+    kind: string;
+    why_action: string[];
+};
+type GuideRenameParam = {
+    target: string;
+    why_rename: string[];
+};
+type GuidePathOp = {
+    method: string;
+    why_op: string[];
+    transform: {
+        req: any;
+        res: any;
+    };
+};
+export { KIT, OpenControlShape, OpenModelShape, OpenBuildShape, };
+export type { Guide, GuideMetrics, GuideEntity, GuidePath, GuidePathAction, GuideRenameParam, GuidePathOp, KitModel, MethodName, TypeName, Log, FsUtil, ApiDefOptions, ApiDefResult, Control, Model, Build, ApiModel, ApiDefContext, Warner, Metrics, };
+export type { CmpDesc, BasicMethodDesc, MethodDesc, MethodEntityDesc, EntityDesc, EntityPathDesc, PathDesc, OpDesc, } from './desc';
+export type { OpName, ModelEntityRelations, ModelOpMap, ModelFieldOp, ModelField, ModelArg, ModelAlt, ModelOp, ModelEntity, } from './model';

package/dist/types.js

@@ -1,8 +1,10 @@
 "use strict";
 /* Copyright (c) 2025 Voxgig, MIT License */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenBuildShape = exports.OpenModelShape = exports.OpenControlShape = void 0;
+exports.OpenBuildShape = exports.OpenModelShape = exports.OpenControlShape = exports.KIT = void 0;
 const gubu_1 = require("gubu");
+const KIT = 'kit';
+exports.KIT = KIT;
 const ControlShape = (0, gubu_1.Gubu)({
     step: {
         parse: true,
@@ -18,7 +20,7 @@ const ModelShape = (0, gubu_1.Gubu)({
     name: String,
     def: String,
     main: {
-        sdk: {},
+        [KIT]: {},
         def: {},
         api: {
             guide: {},

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,4CAA4C;;;AAK5C,+BAAsC;AAkBtC,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC;IACxB,IAAI,EAAE;QACJ,KAAK,EAAE,IAAI;QACX,KAAK,EAAE,IAAI;QACX,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KACf;CACF,CAAC,CAAA;AACF,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;AAyEpE,4CAAgB;AAnElB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC;IACtB,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,MAAM;IACX,IAAI,EAAE;QACJ,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;QACP,GAAG,EAAE;YACH,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,EAAE;SACX;KACF;CACF,CAAC,CAAA;AACF,MAAM,cAAc,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;AAwD9D,wCAAc;AAnDhB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC;IACtB,IAAI,EAAE;QACJ,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;QACP,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,EAAE;QACP,EAAE,EAAE,IAAA,UAAG,GAAE;QACT,MAAM,EAAE,KAAK;QACb,SAAS,EAAE,EAAE;QACb,KAAK,EAAE;YACL,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI;SACV;KACF;CACF,CAAC,CAAA;AACF,MAAM,cAAc,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,UAAU,CAAC,CAAC,CAAA;AAiC3C,wCAAc"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,4CAA4C;;;AAK5C,+BAAsC;AAGtC,MAAM,GAAG,GAAG,KAAK,CAAA;AAyOf,kBAAG;AAzML,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC;IACxB,IAAI,EAAE;QACJ,KAAK,EAAE,IAAI;QACX,KAAK,EAAE,IAAI;QACX,YAAY,EAAE,IAAI;QAClB,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KACf;CACF,CAAC,CAAA;AACF,MAAM,gBAAgB,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;AAkMpE,4CAAgB;AA5LlB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC;IACtB,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,MAAM;IACX,IAAI,EAAE;QACJ,CAAC,GAAG,CAAC,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE;YACH,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,EAAE;SACX;KACF;CACF,CAAC,CAAA;AACF,MAAM,cAAc,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;AAiL9D,wCAAc;AA5KhB,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC;IACtB,IAAI,EAAE;QACJ,IAAI,EAAE,EAAE;QACR,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,GAAG,EAAE,EAAE;QACP,GAAG,EAAE,EAAE;QACP,OAAO,EAAE,EAAE;QACX,GAAG,EAAE,EAAE;QACP,EAAE,EAAE,IAAA,UAAG,GAAE;QACT,MAAM,EAAE,KAAK;QACb,SAAS,EAAE,EAAE;QACb,KAAK,EAAE;YACL,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI;YACT,GAAG,EAAE,IAAI;SACV;KACF;CACF,CAAC,CAAA;AACF,MAAM,cAAc,GAAG,IAAA,WAAI,EAAC,IAAA,WAAI,EAAC,UAAU,CAAC,CAAC,CAAA;AA0J3C,wCAAc"}

package/dist/utility.d.ts

@@ -1,4 +1,9 @@
-import type { FsUtil, Log } from './types';
+import type { FsUtil, Log, Warner } from './types';
+declare function makeWarner(spec: {
+    point: string;
+    log: Log;
+}): Warner;
+declare function writeFileSyncWarn(warn: Warner, fs: any, path: string, text: string): void;
 declare function getdlog(tagin?: string, filepath?: string): ((...args: any[]) => void) & {
     tag: string;
     file: string;
@@ -9,4 +14,31 @@ declare function formatJsonSrc(jsonsrc: string): string;
 declare function depluralize(word: string): string;
 declare function find(obj: any, qkey: string): any[];
 declare function capture(data: any, shape: any): Record<string, any>;
-export { getdlog, loadFile, formatJsonSrc, depluralize, find, capture, };
+type PathMatch = (string[] & {
+    index: number;
+    expr: string;
+    path: string;
+});
+declare function pathMatch(path: string | string[], expr: string): null | PathMatch;
+declare function formatJSONIC(val?: any, opts?: {
+    hsepd?: number;
+    $?: boolean;
+    color?: boolean;
+    maxlines?: number;
+    exclude?: string[];
+}): string;
+declare function validator(torig: undefined | string | string[]): any;
+declare function canonize(s: string): string;
+declare function warnOnError(where: string, warn: Warner, fn: Function, result?: any): any;
+declare function debugpath(pathStr: string, methodName: string | null | undefined, ...args: any[]): void;
+declare function findPathsWithPrefix(ctx: any, pathStr: string, opts?: {
+    strict?: boolean;
+    param?: boolean;
+}): number;
+declare function nom(v: any, format: string): string;
+declare function relativizePath(path: string): string;
+declare function getModelPath(model: any, path: string, flags?: {
+    required?: boolean;
+}): any;
+export type { PathMatch };
+export { nom, getdlog, loadFile, formatJsonSrc, depluralize, find, capture, pathMatch, makeWarner, formatJSONIC, validator, canonize, debugpath, findPathsWithPrefix, writeFileSyncWarn, warnOnError, relativizePath, getModelPath, };