vovk 3.0.0-draft.314 → 3.0.0-draft.316

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.
Files changed (3) hide show
  1. package/cjs/types.d.ts +12 -4
  2. package/mjs/types.d.ts +12 -4
  3. package/package.json +5 -6
package/cjs/types.d.ts CHANGED
@@ -254,6 +254,9 @@ export declare enum VovkSchemaIdEnum {
254
254
  SEGMENT = "https://vovk.dev/api/spec/v3/segment.json",
255
255
  SCHEMA = "https://vovk.dev/api/spec/v3/schema.json"
256
256
  }
257
+ type ReadmeConfig = {
258
+ banner?: string;
259
+ };
257
260
  type ClientConfigCommon = {
258
261
  enabled?: boolean;
259
262
  outDir?: string;
@@ -265,11 +268,13 @@ type ClientConfigCommon = {
265
268
  excludeSegments?: string[];
266
269
  includeSegments?: never;
267
270
  });
268
- type ClientConfigFull = ClientConfigCommon & {
271
+ type ClientConfigComposed = ClientConfigCommon & {
269
272
  package?: PackageJson;
273
+ readme?: ReadmeConfig;
270
274
  };
271
275
  type ClientConfigSegmented = ClientConfigCommon & {
272
276
  packages?: Record<string, PackageJson>;
277
+ readmes?: Record<string, ReadmeConfig>;
273
278
  };
274
279
  type BundleConfig = {
275
280
  outDir?: string;
@@ -277,6 +282,8 @@ type BundleConfig = {
277
282
  tsClientOutDir?: string;
278
283
  dontDeleteTsClientOutDirAfter?: boolean;
279
284
  sourcemap?: boolean;
285
+ package?: PackageJson;
286
+ readme?: ReadmeConfig;
280
287
  } & ({
281
288
  excludeSegments?: never;
282
289
  includeSegments?: string[];
@@ -293,7 +300,7 @@ export type ClientTemplateDef = {
293
300
  extends?: string;
294
301
  templatePath?: string | null;
295
302
  origin?: string | null;
296
- composedClient?: Omit<ClientConfigFull, 'fromTemplates' | 'enabled'>;
303
+ composedClient?: Omit<ClientConfigComposed, 'fromTemplates' | 'enabled'>;
297
304
  segmentedClient?: Omit<ClientConfigSegmented, 'fromTemplates' | 'enabled'>;
298
305
  segmentConfig?: false | SegmentConfig;
299
306
  requires?: Record<string, string>;
@@ -309,7 +316,7 @@ type VovkUserConfig = {
309
316
  $schema?: typeof VovkSchemaIdEnum.CONFIG | string;
310
317
  emitConfig?: boolean | (keyof VovkStrictConfig | string)[];
311
318
  schemaOutDir?: string;
312
- composedClient?: ClientConfigFull;
319
+ composedClient?: ClientConfigComposed;
313
320
  segmentedClient?: ClientConfigSegmented;
314
321
  bundle?: BundleConfig;
315
322
  imports?: {
@@ -346,6 +353,7 @@ type VovkUserConfig = {
346
353
  object: OpenAPIObject;
347
354
  };
348
355
  package?: PackageJson;
356
+ readme?: ReadmeConfig;
349
357
  apiRoot?: string;
350
358
  getModuleName?: 'nestjs-operation-id' | (string & {}) | 'api' | GetOpenAPINameFn;
351
359
  getMethodName?: 'nestjs-operation-id' | 'camel-case-operation-id' | 'auto' | GetOpenAPINameFn;
@@ -363,7 +371,7 @@ export type VovkStrictConfig = Required<Omit<VovkUserConfig, 'emitConfig' | 'lib
363
371
  createRPC: [string, string] | [string];
364
372
  };
365
373
  libs: Record<string, KnownAny>;
366
- composedClient: RequireFields<ClientConfigFull, 'enabled' | 'fromTemplates' | 'outDir'>;
374
+ composedClient: RequireFields<ClientConfigComposed, 'enabled' | 'fromTemplates' | 'outDir'>;
367
375
  segmentedClient: RequireFields<ClientConfigSegmented, 'enabled' | 'fromTemplates' | 'outDir'>;
368
376
  openApiMixins: {
369
377
  [mixinName: string]: {
package/mjs/types.d.ts CHANGED
@@ -254,6 +254,9 @@ export declare enum VovkSchemaIdEnum {
254
254
  SEGMENT = "https://vovk.dev/api/spec/v3/segment.json",
255
255
  SCHEMA = "https://vovk.dev/api/spec/v3/schema.json"
256
256
  }
257
+ type ReadmeConfig = {
258
+ banner?: string;
259
+ };
257
260
  type ClientConfigCommon = {
258
261
  enabled?: boolean;
259
262
  outDir?: string;
@@ -265,11 +268,13 @@ type ClientConfigCommon = {
265
268
  excludeSegments?: string[];
266
269
  includeSegments?: never;
267
270
  });
268
- type ClientConfigFull = ClientConfigCommon & {
271
+ type ClientConfigComposed = ClientConfigCommon & {
269
272
  package?: PackageJson;
273
+ readme?: ReadmeConfig;
270
274
  };
271
275
  type ClientConfigSegmented = ClientConfigCommon & {
272
276
  packages?: Record<string, PackageJson>;
277
+ readmes?: Record<string, ReadmeConfig>;
273
278
  };
274
279
  type BundleConfig = {
275
280
  outDir?: string;
@@ -277,6 +282,8 @@ type BundleConfig = {
277
282
  tsClientOutDir?: string;
278
283
  dontDeleteTsClientOutDirAfter?: boolean;
279
284
  sourcemap?: boolean;
285
+ package?: PackageJson;
286
+ readme?: ReadmeConfig;
280
287
  } & ({
281
288
  excludeSegments?: never;
282
289
  includeSegments?: string[];
@@ -293,7 +300,7 @@ export type ClientTemplateDef = {
293
300
  extends?: string;
294
301
  templatePath?: string | null;
295
302
  origin?: string | null;
296
- composedClient?: Omit<ClientConfigFull, 'fromTemplates' | 'enabled'>;
303
+ composedClient?: Omit<ClientConfigComposed, 'fromTemplates' | 'enabled'>;
297
304
  segmentedClient?: Omit<ClientConfigSegmented, 'fromTemplates' | 'enabled'>;
298
305
  segmentConfig?: false | SegmentConfig;
299
306
  requires?: Record<string, string>;
@@ -309,7 +316,7 @@ type VovkUserConfig = {
309
316
  $schema?: typeof VovkSchemaIdEnum.CONFIG | string;
310
317
  emitConfig?: boolean | (keyof VovkStrictConfig | string)[];
311
318
  schemaOutDir?: string;
312
- composedClient?: ClientConfigFull;
319
+ composedClient?: ClientConfigComposed;
313
320
  segmentedClient?: ClientConfigSegmented;
314
321
  bundle?: BundleConfig;
315
322
  imports?: {
@@ -346,6 +353,7 @@ type VovkUserConfig = {
346
353
  object: OpenAPIObject;
347
354
  };
348
355
  package?: PackageJson;
356
+ readme?: ReadmeConfig;
349
357
  apiRoot?: string;
350
358
  getModuleName?: 'nestjs-operation-id' | (string & {}) | 'api' | GetOpenAPINameFn;
351
359
  getMethodName?: 'nestjs-operation-id' | 'camel-case-operation-id' | 'auto' | GetOpenAPINameFn;
@@ -363,7 +371,7 @@ export type VovkStrictConfig = Required<Omit<VovkUserConfig, 'emitConfig' | 'lib
363
371
  createRPC: [string, string] | [string];
364
372
  };
365
373
  libs: Record<string, KnownAny>;
366
- composedClient: RequireFields<ClientConfigFull, 'enabled' | 'fromTemplates' | 'outDir'>;
374
+ composedClient: RequireFields<ClientConfigComposed, 'enabled' | 'fromTemplates' | 'outDir'>;
367
375
  segmentedClient: RequireFields<ClientConfigSegmented, 'enabled' | 'fromTemplates' | 'outDir'>;
368
376
  openApiMixins: {
369
377
  [mixinName: string]: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vovk",
3
- "version": "3.0.0-draft.314",
3
+ "version": "3.0.0-draft.316",
4
4
  "main": "./cjs/index.js",
5
5
  "module": "./mjs/index.js",
6
6
  "types": "./mjs/index.d.ts",
@@ -41,13 +41,12 @@
41
41
  },
42
42
  "homepage": "https://vovk.dev",
43
43
  "peerDependencies": {
44
- "next": "*"
45
- },
46
- "devDependencies": {
47
- "type-fest": "*"
44
+ "next": "*",
45
+ "openapi3-ts": "^4.4.0"
48
46
  },
47
+ "devDependencies": {},
49
48
  "dependencies": {
50
49
  "@standard-schema/spec": "^1.0.0",
51
- "openapi3-ts": "^4.4.0"
50
+ "type-fest": "*"
52
51
  }
53
52
  }