@lokalise/api-contracts 4.1.2 → 5.0.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/apiContracts.d.ts +13 -11
- package/dist/apiContracts.js +3 -0
- package/dist/apiContracts.js.map +1 -1
- package/package.json +8 -7
package/dist/apiContracts.d.ts
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
|
-
import type { ZodSchema, z } from 'zod';
|
|
2
|
-
import type { HttpStatusCode } from './HttpStatusCodes.
|
|
1
|
+
import type { ZodSchema, z } from 'zod/v4';
|
|
2
|
+
import type { HttpStatusCode } from './HttpStatusCodes.ts';
|
|
3
|
+
export type { HttpStatusCode };
|
|
3
4
|
export type InferSchemaInput<T extends ZodSchema | undefined> = T extends ZodSchema ? z.input<T> : T extends undefined ? undefined : never;
|
|
4
5
|
export type InferSchemaOutput<T extends ZodSchema | undefined> = T extends ZodSchema ? z.infer<T> : T extends undefined ? undefined : never;
|
|
5
6
|
export type RoutePathResolver<PathParams> = (pathParams: PathParams) => string;
|
|
6
7
|
export interface CommonRouteDefinitionMetadata extends Record<string, unknown> {
|
|
7
8
|
}
|
|
8
|
-
export type CommonRouteDefinition<
|
|
9
|
+
export type CommonRouteDefinition<ResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false> = {
|
|
9
10
|
isNonJSONResponseExpected?: IsNonJSONResponseExpected;
|
|
10
11
|
isEmptyResponseExpected?: IsEmptyResponseExpected;
|
|
11
12
|
successResponseBodySchema: ResponseBodySchema;
|
|
@@ -14,24 +15,25 @@ export type CommonRouteDefinition<PathParams, ResponseBodySchema extends z.Schem
|
|
|
14
15
|
requestHeaderSchema?: RequestHeaderSchema;
|
|
15
16
|
pathResolver: RoutePathResolver<InferSchemaOutput<PathParamsSchema>>;
|
|
16
17
|
responseSchemasByStatusCode?: Partial<Record<HttpStatusCode, z.Schema>>;
|
|
18
|
+
metadata?: CommonRouteDefinitionMetadata;
|
|
17
19
|
description?: string;
|
|
18
20
|
summary?: string;
|
|
19
|
-
|
|
21
|
+
tags?: readonly string[];
|
|
20
22
|
};
|
|
21
|
-
export type PayloadRouteDefinition<
|
|
23
|
+
export type PayloadRouteDefinition<RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false> = CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected> & {
|
|
22
24
|
method: 'post' | 'put' | 'patch';
|
|
23
25
|
requestBodySchema: RequestBodySchema;
|
|
24
26
|
};
|
|
25
|
-
export type GetRouteDefinition<
|
|
27
|
+
export type GetRouteDefinition<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false> = CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected> & {
|
|
26
28
|
method: 'get';
|
|
27
29
|
};
|
|
28
|
-
export type DeleteRouteDefinition<
|
|
30
|
+
export type DeleteRouteDefinition<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = true> = CommonRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected> & {
|
|
29
31
|
method: 'delete';
|
|
30
32
|
};
|
|
31
|
-
export declare function buildPayloadRoute<RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false
|
|
32
|
-
export declare function buildGetRoute<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false
|
|
33
|
-
export declare function buildDeleteRoute<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = true
|
|
33
|
+
export declare function buildPayloadRoute<RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false>(params: PayloadRouteDefinition<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>): PayloadRouteDefinition<RequestBodySchema, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>;
|
|
34
|
+
export declare function buildGetRoute<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false>(params: Omit<GetRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>, 'method'>): GetRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>;
|
|
35
|
+
export declare function buildDeleteRoute<SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = true>(params: Omit<DeleteRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>, 'method'>): DeleteRouteDefinition<SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected>;
|
|
34
36
|
/**
|
|
35
37
|
* This method maps given route definition to a string of the format '/static-path-part/:path-param-value'
|
|
36
38
|
*/
|
|
37
|
-
export declare function mapRouteToPath(routeDefinition: CommonRouteDefinition<any, any, any, any, any, any
|
|
39
|
+
export declare function mapRouteToPath(routeDefinition: CommonRouteDefinition<any, any, any, any, any, any>): string;
|
package/dist/apiContracts.js
CHANGED
|
@@ -14,6 +14,7 @@ export function buildPayloadRoute(params) {
|
|
|
14
14
|
summary: params.summary,
|
|
15
15
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
16
16
|
metadata: params.metadata,
|
|
17
|
+
tags: params.tags,
|
|
17
18
|
};
|
|
18
19
|
}
|
|
19
20
|
export function buildGetRoute(params) {
|
|
@@ -30,6 +31,7 @@ export function buildGetRoute(params) {
|
|
|
30
31
|
summary: params.summary,
|
|
31
32
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
32
33
|
metadata: params.metadata,
|
|
34
|
+
tags: params.tags,
|
|
33
35
|
};
|
|
34
36
|
}
|
|
35
37
|
export function buildDeleteRoute(params) {
|
|
@@ -46,6 +48,7 @@ export function buildDeleteRoute(params) {
|
|
|
46
48
|
summary: params.summary,
|
|
47
49
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
48
50
|
metadata: params.metadata,
|
|
51
|
+
tags: params.tags,
|
|
49
52
|
};
|
|
50
53
|
}
|
|
51
54
|
/**
|
package/dist/apiContracts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"AAKA,MAAM,YAAY,GAAG,EAAE,CAAA;AA2GvB,MAAM,UAAU,iBAAiB,CAS/B,MAQC;IAUD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,iBAAiB,EAAE,MAAM,CAAC,iBAAiB;QAC3C,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;QAC/D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAQ3B,MAUC;IASD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,KAAiC;QAC7F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,KAAK;QACb,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;QAC/D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAQ9B,MAUC;IASD,OAAO;QACL,uBAAuB,EAAE,MAAM,CAAC,uBAAuB,IAAK,IAAgC;QAC5F,yBAAyB,EACvB,MAAM,CAAC,yBAAyB,IAAK,KAAmC;QAC1E,MAAM,EAAE,QAAQ;QAChB,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,uBAAuB,EAAE,MAAM,CAAC,uBAAuB;QACvD,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;QAC/D,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;AAC5B,sGAAsG;AACtG,eAAoE;IAEpE,IAAI,CAAC,eAAe,CAAC,uBAAuB,EAAE,CAAC;QAC7C,OAAO,eAAe,CAAC,YAAY,CAAC,YAAY,CAAC,CAAA;IACnD,CAAC;IACD,MAAM,KAAK,GAAG,eAAe,CAAC,uBAAuB,CAAC,KAAK,CAAA;IAC3D,MAAM,cAAc,GAA2B,EAAE,CAAA;IACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACrC,cAAc,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,CAAA;IACjC,CAAC;IAED,OAAO,eAAe,CAAC,YAAY,CAAC,cAAc,CAAC,CAAA;AACrD,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lokalise/api-contracts",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"files": ["dist"],
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"type": "module",
|
|
@@ -33,22 +33,23 @@
|
|
|
33
33
|
"build": "rimraf dist && tsc --project tsconfig.build.json",
|
|
34
34
|
"lint": "biome check . && tsc",
|
|
35
35
|
"lint:fix": "biome check --write",
|
|
36
|
+
"test": "vitest run",
|
|
36
37
|
"test:ci": "vitest run --coverage",
|
|
37
38
|
"prepublishOnly": "npm run build",
|
|
38
39
|
"package-version": "echo $npm_package_version",
|
|
39
40
|
"postversion": "biome check --write package.json"
|
|
40
41
|
},
|
|
41
42
|
"peerDependencies": {
|
|
42
|
-
"zod": "
|
|
43
|
+
"zod": ">=3.25.56"
|
|
43
44
|
},
|
|
44
45
|
"devDependencies": {
|
|
45
46
|
"@biomejs/biome": "^1.9.4",
|
|
46
|
-
"@lokalise/biome-config": "^
|
|
47
|
-
"@lokalise/tsconfig": "
|
|
48
|
-
"@vitest/coverage-v8": "^3.
|
|
47
|
+
"@lokalise/biome-config": "^2.0.0",
|
|
48
|
+
"@lokalise/tsconfig": "^1.3.0",
|
|
49
|
+
"@vitest/coverage-v8": "^3.2.2",
|
|
49
50
|
"rimraf": "^6.0.1",
|
|
50
|
-
"typescript": "5.8.
|
|
51
|
-
"vitest": "^3.
|
|
51
|
+
"typescript": "5.8.3",
|
|
52
|
+
"vitest": "^3.2.2"
|
|
52
53
|
},
|
|
53
54
|
"dependencies": {}
|
|
54
55
|
}
|