@sdk-it/typescript 0.25.0 → 0.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +984 -54
- package/dist/index.js.map +4 -4
- package/dist/lib/emitters/snippet.d.ts +3 -2
- package/dist/lib/emitters/snippet.d.ts.map +1 -1
- package/dist/lib/emitters/zod.d.ts.map +1 -1
- package/dist/lib/generate.d.ts.map +1 -1
- package/dist/lib/readme/prop.emitter.d.ts +17 -0
- package/dist/lib/readme/prop.emitter.d.ts.map +1 -0
- package/dist/lib/readme/readme.d.ts +4 -0
- package/dist/lib/readme/readme.d.ts.map +1 -0
- package/dist/lib/typescript-snippet.d.ts +15 -2
- package/dist/lib/typescript-snippet.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { ReferenceObject, SchemaObject } from 'openapi3-ts/oas31';
|
|
2
|
+
import type { OurOpenAPIObject } from '@sdk-it/spec';
|
|
2
3
|
/**
|
|
3
4
|
* Generate example values for OpenAPI schemas
|
|
4
5
|
* This emitter creates sample input payloads for API documentation and code snippets
|
|
@@ -7,7 +8,7 @@ export declare class SnippetEmitter {
|
|
|
7
8
|
private spec;
|
|
8
9
|
generatedRefs: Set<string>;
|
|
9
10
|
private cache;
|
|
10
|
-
constructor(spec:
|
|
11
|
+
constructor(spec: OurOpenAPIObject);
|
|
11
12
|
object(schema: SchemaObject | ReferenceObject): Record<string, unknown>;
|
|
12
13
|
array(schema: SchemaObject | ReferenceObject): unknown[];
|
|
13
14
|
string(schema: SchemaObject): string;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snippet.d.ts","sourceRoot":"","sources":["../../../src/lib/emitters/snippet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"snippet.d.ts","sourceRoot":"","sources":["../../../src/lib/emitters/snippet.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAErD;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,IAAI,CAAmB;IACxB,aAAa,cAAqB;IACzC,OAAO,CAAC,KAAK,CAA8B;gBAE/B,IAAI,EAAE,gBAAgB;IAI3B,MAAM,CACX,MAAM,EAAE,YAAY,GAAG,eAAe,GACrC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IA+BnB,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,GAAG,OAAO,EAAE;IAiBxD,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IAoCpC,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IAgCpC,OAAO,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO;IAMtC,IAAI,IAAI,IAAI;IAIZ,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAiB1B,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,GAAG,OAAO;IAW3D,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,GAAG,OAAO;IAK3D,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,GAAG,OAAO;IAK3D,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO;IAMnC,MAAM,CAAC,WAAW,EAAE,YAAY,GAAG,eAAe,GAAG,OAAO;CAgEpE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zod.d.ts","sourceRoot":"","sources":["../../../src/lib/emitters/zod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACb,MAAM,mBAAmB,CAAC;AAK3B,KAAK,aAAa,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,qBAAa,UAAU;;gBAKT,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,aAAa;IA6DtD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,YAAY,EACpB,QAAQ,UAAQ,EAChB,QAAQ,UAAQ,GACf,MAAM;IAmDT,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAWpE,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAQpE,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAQpE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE;IAYhC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;
|
|
1
|
+
{"version":3,"file":"zod.d.ts","sourceRoot":"","sources":["../../../src/lib/emitters/zod.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACb,MAAM,mBAAmB,CAAC;AAK3B,KAAK,aAAa,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;AAE5D;;;GAGG;AACH,qBAAa,UAAU;;gBAKT,IAAI,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,aAAa;IA6DtD;;;OAGG;IACH,MAAM,CACJ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,YAAY,EACpB,QAAQ,UAAQ,EAChB,QAAQ,UAAQ,GACf,MAAM;IAmDT,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAWpE,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAQpE,KAAK,CAAC,OAAO,EAAE,CAAC,YAAY,GAAG,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO;IAQpE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE;IAYhC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IAmHpC,MAAM,CAAC,MAAM,EAAE,YAAY,GAAG,eAAe,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM;CAiE1E;AAYD,wBAAgB,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,MAAM,CAetE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/lib/generate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../../src/lib/generate.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AA4BvD,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAK/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAkC1C,wBAAsB,QAAQ,CAC5B,OAAO,EAAE,aAAa,EACtB,QAAQ,EAAE,0BAA0B,iBAgPrC;AA+CD,wBAAgB,QAAQ,CACtB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,EAC1C,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,EAC9B,UAAU,EAAE,YAAY,OAsDzB"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { OpenAPIObject, ReferenceObject, RequestBodyObject, SchemaObject } from 'openapi3-ts/oas31';
|
|
2
|
+
/**
|
|
3
|
+
* PropEmitter handles converting OpenAPI schemas to Markdown documentation
|
|
4
|
+
*/
|
|
5
|
+
export declare class PropEmitter {
|
|
6
|
+
#private;
|
|
7
|
+
constructor(spec: OpenAPIObject);
|
|
8
|
+
/**
|
|
9
|
+
* Handle schemas by resolving references and delegating to appropriate handler
|
|
10
|
+
*/
|
|
11
|
+
handle(schemaOrRef: SchemaObject | ReferenceObject): string[];
|
|
12
|
+
/**
|
|
13
|
+
* Process a request body and return markdown documentation
|
|
14
|
+
*/
|
|
15
|
+
requestBody(requestBody?: RequestBodyObject): string[];
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=prop.emitter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prop.emitter.d.ts","sourceRoot":"","sources":["../../../src/lib/readme/prop.emitter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,YAAY,EACb,MAAM,mBAAmB,CAAC;AAK3B;;GAEG;AACH,qBAAa,WAAW;;gBAGV,IAAI,EAAE,aAAa;IAiP/B;;OAEG;IACI,MAAM,CAAC,WAAW,EAAE,YAAY,GAAG,eAAe,GAAG,MAAM,EAAE;IAkEpE;;OAEG;IACH,WAAW,CAAC,WAAW,CAAC,EAAE,iBAAiB,GAAG,MAAM,EAAE;CA4CvD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readme.d.ts","sourceRoot":"","sources":["../../../src/lib/readme/readme.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,KAAK,gBAAgB,EAAoB,MAAM,cAAc,CAAC;AAIvE,wBAAgB,QAAQ,CAAC,IAAI,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,UAgHpE"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import { type Generator } from '@sdk-it/readme';
|
|
1
2
|
import { type OperationEntry, type OurOpenAPIObject, type TunedOperationObject } from '@sdk-it/spec';
|
|
2
3
|
import type { TypeScriptGeneratorOptions } from './options.ts';
|
|
3
|
-
export declare class TypeScriptGenerator {
|
|
4
|
+
export declare class TypeScriptGenerator implements Generator {
|
|
4
5
|
#private;
|
|
5
6
|
constructor(spec: OurOpenAPIObject, settings: TypeScriptGeneratorOptions);
|
|
6
7
|
succinct(entry: OperationEntry, operation: TunedOperationObject, values: {
|
|
@@ -15,6 +16,18 @@ export declare class TypeScriptGenerator {
|
|
|
15
16
|
};
|
|
16
17
|
snippet(entry: OperationEntry, operation: TunedOperationObject, config?: Record<string, unknown>): string;
|
|
17
18
|
client(): string;
|
|
19
|
+
clientInstallDocs(): string;
|
|
20
|
+
configurationOptions(): {
|
|
21
|
+
sections: string[];
|
|
22
|
+
hasServers: boolean;
|
|
23
|
+
baseUrl: string;
|
|
24
|
+
hasApiKey: boolean;
|
|
25
|
+
};
|
|
26
|
+
clientSetupDocs(): string;
|
|
27
|
+
paginationDocs(): string;
|
|
28
|
+
errorHandlingDocs(): string;
|
|
29
|
+
authenticationDocs(): string;
|
|
30
|
+
generalUsageDocs(): string;
|
|
31
|
+
configurationUpdateDocs(): string;
|
|
18
32
|
}
|
|
19
|
-
export declare function generateSnippet(spec: OurOpenAPIObject, settings: TypeScriptGeneratorOptions, entry: OperationEntry, operation: TunedOperationObject, config?: Record<string, unknown>): string;
|
|
20
33
|
//# sourceMappingURL=typescript-snippet.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"typescript-snippet.d.ts","sourceRoot":"","sources":["../../src/lib/typescript-snippet.ts"],"names":[],"mappings":"AAIA,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,
|
|
1
|
+
{"version":3,"file":"typescript-snippet.d.ts","sourceRoot":"","sources":["../../src/lib/typescript-snippet.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EACL,KAAK,cAAc,EAEnB,KAAK,gBAAgB,EACrB,KAAK,oBAAoB,EAI1B,MAAM,cAAc,CAAC;AAGtB,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAE/D,qBAAa,mBAAoB,YAAW,SAAS;;gBAMvC,IAAI,EAAE,gBAAgB,EAAE,QAAQ,EAAE,0BAA0B;IAYxE,QAAQ,CACN,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,oBAAoB,EAC/B,MAAM,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACzC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC;;;;IAmIH,OAAO,CACL,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,oBAAoB,EAC/B,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM;IAwBtC,MAAM;IA2BN,iBAAiB,IAAI,MAAM;IAiB3B,oBAAoB,IAAI;QACtB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,OAAO,CAAC;KACpB;IAyCD,eAAe,IAAI,MAAM;IAkBzB,cAAc,IAAI,MAAM;IA6MxB,iBAAiB,IAAI,MAAM;IAuL3B,kBAAkB,IAAI,MAAM;IA+F5B,gBAAgB,IAAI,MAAM;IAM1B,uBAAuB,IAAI,MAAM;CAkDlC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sdk-it/typescript",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.27.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.js",
|
|
@@ -21,12 +21,12 @@
|
|
|
21
21
|
"!**/*.tsbuildinfo"
|
|
22
22
|
],
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@sdk-it/core": "0.
|
|
24
|
+
"@sdk-it/core": "0.27.0",
|
|
25
25
|
"openapi3-ts": "^4.4.0",
|
|
26
26
|
"stringcase": "^4.3.1",
|
|
27
27
|
"lodash-es": "^4.17.21",
|
|
28
28
|
"npm-run-path": "6.0.0",
|
|
29
|
-
"@sdk-it/spec": "0.
|
|
30
|
-
"@sdk-it/readme": "0.
|
|
29
|
+
"@sdk-it/spec": "0.27.0",
|
|
30
|
+
"@sdk-it/readme": "0.27.0"
|
|
31
31
|
}
|
|
32
32
|
}
|