@lokalise/api-contracts 4.1.0 → 4.1.2
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/README.md +4 -2
- package/dist/apiContracts.d.ts +1 -0
- package/dist/apiContracts.js +3 -0
- package/dist/apiContracts.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,6 +19,7 @@ const getContract = buildGetRoute({
|
|
|
19
19
|
requestQuerySchema: REQUEST_QUERY_SCHEMA,
|
|
20
20
|
requestHeaderSchema: REQUEST_HEADER_SCHEMA,
|
|
21
21
|
pathResolver: (pathParams) => `/users/${pathParams.userId}`,
|
|
22
|
+
summary: 'Route summary',
|
|
22
23
|
metadata: { allowedRoles: ['admin'] },
|
|
23
24
|
})
|
|
24
25
|
|
|
@@ -27,6 +28,7 @@ const postContract = buildPayloadRoute({
|
|
|
27
28
|
successResponseBodySchema: RESPONSE_BODY_SCHEMA,
|
|
28
29
|
requestBodySchema: REQUEST_BODY_SCHEMA,
|
|
29
30
|
pathResolver: () => '/',
|
|
31
|
+
summary: 'Route summary',
|
|
30
32
|
metadata: { allowedPermission: ['edit'] },
|
|
31
33
|
})
|
|
32
34
|
|
|
@@ -46,10 +48,10 @@ Here is how you can apply strict typing to the `metadata` property using TypeScr
|
|
|
46
48
|
```typescript
|
|
47
49
|
// file -> apiContracts.d.ts
|
|
48
50
|
// Import the existing module to ensure TypeScript recognizes the original definitions
|
|
49
|
-
import '@lokalise/api-contracts
|
|
51
|
+
import '@lokalise/api-contracts';
|
|
50
52
|
|
|
51
53
|
// Augment the module to extend the interface with specific properties
|
|
52
|
-
declare module '@lokalise/api-contracts
|
|
54
|
+
declare module '@lokalise/api-contracts' {
|
|
53
55
|
interface CommonRouteDefinitionMetadata {
|
|
54
56
|
myTestProp?: string[];
|
|
55
57
|
mySecondTestProp?: number;
|
package/dist/apiContracts.d.ts
CHANGED
|
@@ -15,6 +15,7 @@ export type CommonRouteDefinition<PathParams, ResponseBodySchema extends z.Schem
|
|
|
15
15
|
pathResolver: RoutePathResolver<InferSchemaOutput<PathParamsSchema>>;
|
|
16
16
|
responseSchemasByStatusCode?: Partial<Record<HttpStatusCode, z.Schema>>;
|
|
17
17
|
description?: string;
|
|
18
|
+
summary?: string;
|
|
18
19
|
metadata?: CommonRouteDefinitionMetadata;
|
|
19
20
|
};
|
|
20
21
|
export type PayloadRouteDefinition<PathParams, RequestBodySchema extends z.Schema | undefined = undefined, SuccessResponseBodySchema extends z.Schema | undefined = undefined, PathParamsSchema extends z.Schema<PathParams> | undefined = undefined, RequestQuerySchema extends z.Schema | undefined = undefined, RequestHeaderSchema extends z.Schema | undefined = undefined, IsNonJSONResponseExpected extends boolean = false, IsEmptyResponseExpected extends boolean = false> = CommonRouteDefinition<PathParams, SuccessResponseBodySchema, PathParamsSchema, RequestQuerySchema, RequestHeaderSchema, IsNonJSONResponseExpected, IsEmptyResponseExpected> & {
|
package/dist/apiContracts.js
CHANGED
|
@@ -11,6 +11,7 @@ export function buildPayloadRoute(params) {
|
|
|
11
11
|
requestQuerySchema: params.requestQuerySchema,
|
|
12
12
|
successResponseBodySchema: params.successResponseBodySchema,
|
|
13
13
|
description: params.description,
|
|
14
|
+
summary: params.summary,
|
|
14
15
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
15
16
|
metadata: params.metadata,
|
|
16
17
|
};
|
|
@@ -26,6 +27,7 @@ export function buildGetRoute(params) {
|
|
|
26
27
|
requestQuerySchema: params.requestQuerySchema,
|
|
27
28
|
successResponseBodySchema: params.successResponseBodySchema,
|
|
28
29
|
description: params.description,
|
|
30
|
+
summary: params.summary,
|
|
29
31
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
30
32
|
metadata: params.metadata,
|
|
31
33
|
};
|
|
@@ -41,6 +43,7 @@ export function buildDeleteRoute(params) {
|
|
|
41
43
|
requestQuerySchema: params.requestQuerySchema,
|
|
42
44
|
successResponseBodySchema: params.successResponseBodySchema,
|
|
43
45
|
description: params.description,
|
|
46
|
+
summary: params.summary,
|
|
44
47
|
responseSchemasByStatusCode: params.responseSchemasByStatusCode,
|
|
45
48
|
metadata: params.metadata,
|
|
46
49
|
};
|
package/dist/apiContracts.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY,GAAG,EAAE,CAAA;
|
|
1
|
+
{"version":3,"file":"apiContracts.js","sourceRoot":"","sources":["../src/apiContracts.ts"],"names":[],"mappings":"AAGA,MAAM,YAAY,GAAG,EAAE,CAAA;AAsGvB,MAAM,UAAU,iBAAiB,CAU/B,MASC;IAWD,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;KAC1B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAS3B,MAWC;IAUD,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;KAC1B,CAAA;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAS9B,MAWC;IAUD,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;KAC1B,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc;AAC5B,sGAAsG;AACtG,eAAyE;IAEzE,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"}
|