@lokalise/content-type-app-engine-contracts 6.11.0 → 7.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.
Files changed (83) hide show
  1. package/README.md +19 -0
  2. package/dist/index.d.ts +0 -2
  3. package/dist/index.js +0 -2
  4. package/dist/index.js.map +1 -1
  5. package/dist/schemas/auth/authApiSchemas.d.ts +174 -133
  6. package/dist/schemas/auth/authApiSchemas.js +21 -24
  7. package/dist/schemas/auth/authApiSchemas.js.map +1 -1
  8. package/dist/schemas/auth/integrationAuthApiSchemas.d.ts +189 -170
  9. package/dist/schemas/auth/integrationAuthApiSchemas.js +17 -31
  10. package/dist/schemas/auth/integrationAuthApiSchemas.js.map +1 -1
  11. package/dist/schemas/cache/cacheApiSchemas.d.ts +59 -80
  12. package/dist/schemas/cache/cacheApiSchemas.js +4 -4
  13. package/dist/schemas/cache/cacheApiSchemas.js.map +1 -1
  14. package/dist/schemas/commonRequestSchemas.d.ts +1 -1
  15. package/dist/schemas/commonRequestSchemas.js +3 -1
  16. package/dist/schemas/commonRequestSchemas.js.map +1 -1
  17. package/dist/schemas/config/integrationConfigApiSchemas.d.ts +80 -70
  18. package/dist/schemas/config/integrationConfigApiSchemas.js +8 -14
  19. package/dist/schemas/config/integrationConfigApiSchemas.js.map +1 -1
  20. package/dist/schemas/connector/connectorApiSchemas.d.ts +703 -1348
  21. package/dist/schemas/connector/connectorApiSchemas.js +12 -14
  22. package/dist/schemas/connector/connectorApiSchemas.js.map +1 -1
  23. package/dist/schemas/connector/connectorSchemas.d.ts +0 -3
  24. package/dist/schemas/content/contentApiSchemas.d.ts +704 -709
  25. package/dist/schemas/content/contentApiSchemas.js +51 -84
  26. package/dist/schemas/content/contentApiSchemas.js.map +1 -1
  27. package/dist/schemas/content/contentExportApiSchemas.d.ts +44 -51
  28. package/dist/schemas/content/contentExportApiSchemas.js +3 -4
  29. package/dist/schemas/content/contentExportApiSchemas.js.map +1 -1
  30. package/dist/schemas/env/envApiSchemas.d.ts +95 -124
  31. package/dist/schemas/env/envApiSchemas.js +17 -14
  32. package/dist/schemas/env/envApiSchemas.js.map +1 -1
  33. package/dist/schemas/filter/filterApiSchemas.d.ts +314 -232
  34. package/dist/schemas/filter/filterApiSchemas.js +20 -20
  35. package/dist/schemas/filter/filterApiSchemas.js.map +1 -1
  36. package/dist/schemas/integration/integrationApiSchemas.d.ts +702 -1349
  37. package/dist/schemas/integration/integrationApiSchemas.js +12 -18
  38. package/dist/schemas/integration/integrationApiSchemas.js.map +1 -1
  39. package/dist/schemas/integration/integrationSchemas.d.ts +0 -3
  40. package/dist/schemas/integrationProject/integrationProjectApiSchemas.d.ts +144 -117
  41. package/dist/schemas/integrationProject/integrationProjectApiSchemas.js +10 -10
  42. package/dist/schemas/integrationProject/integrationProjectApiSchemas.js.map +1 -1
  43. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.d.ts +45 -40
  44. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js +5 -4
  45. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js.map +1 -1
  46. package/dist/schemas/itemGroup/linkItemGroupApiSchemas.d.ts +45 -43
  47. package/dist/schemas/itemGroup/linkItemGroupApiSchemas.js +5 -4
  48. package/dist/schemas/itemGroup/linkItemGroupApiSchemas.js.map +1 -1
  49. package/dist/schemas/itemList/integrationItemListApiSchemas.d.ts +51 -53
  50. package/dist/schemas/itemList/integrationItemListApiSchemas.js +5 -4
  51. package/dist/schemas/itemList/integrationItemListApiSchemas.js.map +1 -1
  52. package/dist/schemas/itemList/itemListContracts.d.ts +40 -45
  53. package/dist/schemas/itemList/itemListContracts.js +5 -4
  54. package/dist/schemas/itemList/itemListContracts.js.map +1 -1
  55. package/dist/schemas/language/languageApiSchemas.d.ts +29 -26
  56. package/dist/schemas/language/languageApiSchemas.js +4 -5
  57. package/dist/schemas/language/languageApiSchemas.js.map +1 -1
  58. package/dist/schemas/link/linkApiSchemas.d.ts +616 -1272
  59. package/dist/schemas/link/linkApiSchemas.js +5 -4
  60. package/dist/schemas/link/linkApiSchemas.js.map +1 -1
  61. package/dist/schemas/link/linkSchemas.d.ts +0 -3
  62. package/dist/schemas/processResult/integrationProcessResultsApiSchemas.d.ts +143 -167
  63. package/dist/schemas/processResult/integrationProcessResultsApiSchemas.js +9 -7
  64. package/dist/schemas/processResult/integrationProcessResultsApiSchemas.js.map +1 -1
  65. package/dist/schemas/project/projectApiSchemas.d.ts +90 -90
  66. package/dist/schemas/project/projectApiSchemas.js +8 -15
  67. package/dist/schemas/project/projectApiSchemas.js.map +1 -1
  68. package/dist/schemas/schedule/scheduleApiSchemas.d.ts +2620 -2487
  69. package/dist/schemas/schedule/scheduleApiSchemas.js +34 -29
  70. package/dist/schemas/schedule/scheduleApiSchemas.js.map +1 -1
  71. package/dist/schemas/settings/settingsApiSchemas.d.ts +136 -189
  72. package/dist/schemas/settings/settingsApiSchemas.js +8 -9
  73. package/dist/schemas/settings/settingsApiSchemas.js.map +1 -1
  74. package/dist/schemas/status/statusApiSchemas.d.ts +53 -64
  75. package/dist/schemas/status/statusApiSchemas.js +5 -9
  76. package/dist/schemas/status/statusApiSchemas.js.map +1 -1
  77. package/package.json +3 -3
  78. package/dist/schemas/preview/integrationPreviewApiSchemas.d.ts +0 -145
  79. package/dist/schemas/preview/integrationPreviewApiSchemas.js +0 -53
  80. package/dist/schemas/preview/integrationPreviewApiSchemas.js.map +0 -1
  81. package/dist/schemas/preview/integrationPreviewSchemas.d.ts +0 -13
  82. package/dist/schemas/preview/integrationPreviewSchemas.js +0 -8
  83. package/dist/schemas/preview/integrationPreviewSchemas.js.map +0 -1
@@ -1,64 +1,53 @@
1
- import { z } from 'zod/v4';
2
- export declare const getJobStatusContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodUnion<readonly [z.ZodObject<{
3
- status: z.ZodEnum<{
4
- active: "active";
5
- completed: "completed";
6
- delayed: "delayed";
7
- failed: "failed";
8
- paused: "paused";
9
- stuck: "stuck";
10
- waiting: "waiting";
11
- }>;
12
- results: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
13
- language: z.ZodString;
14
- affectedGroupIds: z.ZodArray<z.ZodString>;
15
- skippedGroupIds: z.ZodObject<{}, z.core.$loose>;
16
- }, z.core.$strip>>>;
17
- }, z.core.$strip>, z.ZodObject<{
18
- statusCode: z.ZodNumber;
19
- payload: z.ZodObject<{
20
- message: z.ZodString;
21
- code: z.ZodString;
22
- errorCode: z.ZodString;
23
- details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
24
- }, z.core.$strip>;
25
- }, z.core.$strip>]>, z.ZodObject<{
26
- id: z.ZodString;
27
- }, z.core.$strip>, undefined, z.ZodObject<{
28
- authorization: z.ZodOptional<z.ZodString>;
29
- }, z.core.$strip>, undefined, false, false, {
30
- 200: z.ZodObject<{
31
- status: z.ZodEnum<{
32
- active: "active";
33
- completed: "completed";
34
- delayed: "delayed";
35
- failed: "failed";
36
- paused: "paused";
37
- stuck: "stuck";
38
- waiting: "waiting";
39
- }>;
40
- results: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
41
- language: z.ZodString;
42
- affectedGroupIds: z.ZodArray<z.ZodString>;
43
- skippedGroupIds: z.ZodObject<{}, z.core.$loose>;
44
- }, z.core.$strip>>>;
45
- }, z.core.$strip>;
46
- 401: z.ZodObject<{
47
- statusCode: z.ZodNumber;
48
- payload: z.ZodObject<{
49
- message: z.ZodString;
50
- code: z.ZodString;
51
- errorCode: z.ZodString;
52
- details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
53
- }, z.core.$strip>;
54
- }, z.core.$strip>;
55
- 404: z.ZodObject<{
56
- statusCode: z.ZodNumber;
57
- payload: z.ZodObject<{
58
- message: z.ZodString;
59
- code: z.ZodString;
60
- errorCode: z.ZodString;
61
- details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
62
- }, z.core.$strip>;
63
- }, z.core.$strip>;
64
- }>;
1
+ export declare const getJobStatusContract: Omit<{
2
+ readonly visibility: "internal";
3
+ readonly method: "get";
4
+ readonly pathResolver: ({ id }: {
5
+ id: string;
6
+ }) => string;
7
+ readonly summary: "Get job status by ID";
8
+ readonly requestPathParamsSchema: import("zod").ZodObject<{
9
+ id: import("zod").ZodString;
10
+ }, import("zod/v4/core").$strip>;
11
+ readonly responsesByStatusCode: {
12
+ 200: import("zod").ZodObject<{
13
+ status: import("zod").ZodEnum<{
14
+ active: "active";
15
+ completed: "completed";
16
+ delayed: "delayed";
17
+ failed: "failed";
18
+ paused: "paused";
19
+ stuck: "stuck";
20
+ waiting: "waiting";
21
+ }>;
22
+ results: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
23
+ language: import("zod").ZodString;
24
+ affectedGroupIds: import("zod").ZodArray<import("zod").ZodString>;
25
+ skippedGroupIds: import("zod").ZodObject<{}, import("zod/v4/core").$loose>;
26
+ }, import("zod/v4/core").$strip>>>;
27
+ }, import("zod/v4/core").$strip>;
28
+ 401: import("zod").ZodObject<{
29
+ statusCode: import("zod").ZodNumber;
30
+ payload: import("zod").ZodObject<{
31
+ message: import("zod").ZodString;
32
+ code: import("zod").ZodString;
33
+ errorCode: import("zod").ZodString;
34
+ details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
35
+ }, import("zod/v4/core").$strip>;
36
+ }, import("zod/v4/core").$strip>;
37
+ 404: import("zod").ZodObject<{
38
+ statusCode: import("zod").ZodNumber;
39
+ payload: import("zod").ZodObject<{
40
+ message: import("zod").ZodString;
41
+ code: import("zod").ZodString;
42
+ errorCode: import("zod").ZodString;
43
+ details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
44
+ }, import("zod/v4/core").$strip>;
45
+ }, import("zod/v4/core").$strip>;
46
+ };
47
+ readonly requestHeaderSchema: import("zod").ZodObject<{
48
+ authorization: import("zod").ZodOptional<import("zod").ZodString>;
49
+ }, import("zod/v4/core").$loose>;
50
+ readonly tags: string[];
51
+ }, "visibility"> & {
52
+ visibility: import("@lokalise/api-contracts").RouteVisibility;
53
+ };
@@ -1,18 +1,14 @@
1
- import { buildGetRoute } from '@lokalise/api-contracts';
2
- import { z } from 'zod/v4';
1
+ import { defineApiContract } from '@lokalise/api-contracts';
3
2
  import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA, } from '../commonRequestSchemas.js';
4
3
  import { GET_JOB_STATUS_REQUEST_PATH_PARAMS_SCHEMA, GET_JOB_STATUS_RESPONSE_SCHEMA, } from './statusSchemas.js';
5
4
  const tags = ['Status'];
6
- export const getJobStatusContract = buildGetRoute({
5
+ export const getJobStatusContract = defineApiContract({
7
6
  visibility: 'internal',
7
+ method: 'get',
8
8
  pathResolver: ({ id }) => `/v1/status/jobs/${id}`,
9
- description: 'Get job status by ID',
9
+ summary: 'Get job status by ID',
10
10
  requestPathParamsSchema: GET_JOB_STATUS_REQUEST_PATH_PARAMS_SCHEMA,
11
- successResponseBodySchema: z.union([
12
- GET_JOB_STATUS_RESPONSE_SCHEMA,
13
- COMMON_ERROR_RESPONSE_SCHEMA,
14
- ]),
15
- responseSchemasByStatusCode: {
11
+ responsesByStatusCode: {
16
12
  200: GET_JOB_STATUS_RESPONSE_SCHEMA,
17
13
  401: COMMON_ERROR_RESPONSE_SCHEMA,
18
14
  404: COMMON_ERROR_RESPONSE_SCHEMA,
@@ -1 +1 @@
1
- {"version":3,"file":"statusApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/status/statusApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,yCAAyC,EACzC,8BAA8B,GAC/B,MAAM,oBAAoB,CAAA;AAE3B,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAA;AAEvB,MAAM,CAAC,MAAM,oBAAoB,GAAG,aAAa,CAAC;IAChD,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,mBAAmB,EAAE,EAAE;IACjD,WAAW,EAAE,sBAAsB;IACnC,uBAAuB,EAAE,yCAAyC;IAClE,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC;QACjC,8BAA8B;QAC9B,4BAA4B;KAC7B,CAAC;IACF,2BAA2B,EAAE;QAC3B,GAAG,EAAE,8BAA8B;QACnC,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA"}
1
+ {"version":3,"file":"statusApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/status/statusApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,GAC7B,MAAM,4BAA4B,CAAA;AACnC,OAAO,EACL,yCAAyC,EACzC,8BAA8B,GAC/B,MAAM,oBAAoB,CAAA;AAE3B,MAAM,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAA;AAEvB,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,mBAAmB,EAAE,EAAE;IACjD,OAAO,EAAE,sBAAsB;IAC/B,uBAAuB,EAAE,yCAAyC;IAClE,qBAAqB,EAAE;QACrB,GAAG,EAAE,8BAA8B;QACnC,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/content-type-app-engine-contracts",
3
- "version": "6.11.0",
3
+ "version": "7.0.0",
4
4
  "description": "Content Type App Engine service contracts",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -13,11 +13,11 @@
13
13
  },
14
14
  "peerDependencies": {
15
15
  "@lokalise/api-common": ">=6.1.0",
16
- "@lokalise/api-contracts": ">=7.2.0",
16
+ "@lokalise/api-contracts": ">=8.0.0",
17
17
  "zod": ">=4.5.0 <5.0.0"
18
18
  },
19
19
  "dependencies": {
20
- "@lokalise/connector-api-contracts": "^11.9.0",
20
+ "@lokalise/connector-api-contracts": "^11.10.0",
21
21
  "@lokalise/content-conversion-api-schemas": "^1.1.0"
22
22
  },
23
23
  "devDependencies": {
@@ -1,145 +0,0 @@
1
- /**
2
- * Contract for resolving the connected site and its staging origin for in-context preview
3
- * GET /v1/integrations/{integrationId}/preview-site
4
- *
5
- * Proxies the connector's `GET /v1/preview-site` with the integration's stored auth.
6
- * The response is the connector contract's typed `available` / `unavailable` state;
7
- * connectors without preview support answer 400 `PREVIEW_NOT_SUPPORTED`.
8
- *
9
- * Accepts service-to-service tokens (the preview proxy) as well as user tokens
10
- * with access to the integration.
11
- */
12
- export declare const getIntegrationPreviewSiteContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
13
- state: import("zod").ZodLiteral<"available">;
14
- site: import("zod").ZodObject<{
15
- id: import("zod").ZodString;
16
- name: import("zod").ZodString;
17
- stagingOrigin: import("zod").ZodString;
18
- lastPublishedAt: import("zod").ZodNullable<import("zod").ZodISODateTime>;
19
- assetOrigins: import("zod").ZodArray<import("zod").ZodString>;
20
- }, import("zod/v4/core").$strip>;
21
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
22
- state: import("zod").ZodLiteral<"unavailable">;
23
- reason: import("zod").ZodEnum<{
24
- SITE_NOT_FOUND: "SITE_NOT_FOUND";
25
- SITE_NOT_PUBLISHED: "SITE_NOT_PUBLISHED";
26
- NO_STAGING_ORIGIN: "NO_STAGING_ORIGIN";
27
- }>;
28
- }, import("zod/v4/core").$strip>], "state">, import("zod").ZodObject<{
29
- integrationId: import("zod").ZodGUID;
30
- }, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
31
- authorization: import("zod").ZodOptional<import("zod").ZodString>;
32
- }, import("zod/v4/core").$strip>, undefined, false, false, {
33
- 200: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
34
- state: import("zod").ZodLiteral<"available">;
35
- site: import("zod").ZodObject<{
36
- id: import("zod").ZodString;
37
- name: import("zod").ZodString;
38
- stagingOrigin: import("zod").ZodString;
39
- lastPublishedAt: import("zod").ZodNullable<import("zod").ZodISODateTime>;
40
- assetOrigins: import("zod").ZodArray<import("zod").ZodString>;
41
- }, import("zod/v4/core").$strip>;
42
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
43
- state: import("zod").ZodLiteral<"unavailable">;
44
- reason: import("zod").ZodEnum<{
45
- SITE_NOT_FOUND: "SITE_NOT_FOUND";
46
- SITE_NOT_PUBLISHED: "SITE_NOT_PUBLISHED";
47
- NO_STAGING_ORIGIN: "NO_STAGING_ORIGIN";
48
- }>;
49
- }, import("zod/v4/core").$strip>], "state">;
50
- 400: import("zod").ZodObject<{
51
- message: import("zod").ZodString;
52
- code: import("zod").ZodString;
53
- errorCode: import("zod").ZodString;
54
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
55
- }, import("zod/v4/core").$strip>;
56
- 401: import("zod").ZodObject<{
57
- message: import("zod").ZodString;
58
- code: import("zod").ZodString;
59
- errorCode: import("zod").ZodString;
60
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
61
- }, import("zod/v4/core").$strip>;
62
- 404: import("zod").ZodObject<{
63
- message: import("zod").ZodString;
64
- code: import("zod").ZodString;
65
- errorCode: import("zod").ZodString;
66
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
67
- }, import("zod/v4/core").$strip>;
68
- }>;
69
- /**
70
- * Contract for resolving the pages that render an item, for in-context preview
71
- * GET /v1/integrations/{integrationId}/preview-targets?itemId=
72
- *
73
- * `itemId` is the connector item identifier (`ItemIdentifier.groupId`), which
74
- * autopilot stores as the content item `sourceId`. Paths are relative to the
75
- * staging origin returned by the preview-site endpoint.
76
- */
77
- export declare const getIntegrationPreviewTargetsContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
78
- state: import("zod").ZodLiteral<"resolved">;
79
- siteId: import("zod").ZodString;
80
- targets: import("zod").ZodArray<import("zod").ZodObject<{
81
- id: import("zod").ZodString;
82
- path: import("zod").ZodString;
83
- label: import("zod").ZodString;
84
- kind: import("zod").ZodEnum<{
85
- page: "page";
86
- collection_index: "collection_index";
87
- collection_detail: "collection_detail";
88
- }>;
89
- }, import("zod/v4/core").$strip>>;
90
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
91
- state: import("zod").ZodLiteral<"unsupported">;
92
- siteId: import("zod").ZodString;
93
- reason: import("zod").ZodEnum<{
94
- ITEM_NOT_FOUND: "ITEM_NOT_FOUND";
95
- ITEM_NOT_PREVIEWABLE: "ITEM_NOT_PREVIEWABLE";
96
- ITEM_NOT_PUBLISHED: "ITEM_NOT_PUBLISHED";
97
- }>;
98
- }, import("zod/v4/core").$strip>], "state">, import("zod").ZodObject<{
99
- integrationId: import("zod").ZodGUID;
100
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
101
- itemId: import("zod").ZodString;
102
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
103
- authorization: import("zod").ZodOptional<import("zod").ZodString>;
104
- }, import("zod/v4/core").$strip>, undefined, false, false, {
105
- 200: import("zod").ZodDiscriminatedUnion<[import("zod").ZodObject<{
106
- state: import("zod").ZodLiteral<"resolved">;
107
- siteId: import("zod").ZodString;
108
- targets: import("zod").ZodArray<import("zod").ZodObject<{
109
- id: import("zod").ZodString;
110
- path: import("zod").ZodString;
111
- label: import("zod").ZodString;
112
- kind: import("zod").ZodEnum<{
113
- page: "page";
114
- collection_index: "collection_index";
115
- collection_detail: "collection_detail";
116
- }>;
117
- }, import("zod/v4/core").$strip>>;
118
- }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
119
- state: import("zod").ZodLiteral<"unsupported">;
120
- siteId: import("zod").ZodString;
121
- reason: import("zod").ZodEnum<{
122
- ITEM_NOT_FOUND: "ITEM_NOT_FOUND";
123
- ITEM_NOT_PREVIEWABLE: "ITEM_NOT_PREVIEWABLE";
124
- ITEM_NOT_PUBLISHED: "ITEM_NOT_PUBLISHED";
125
- }>;
126
- }, import("zod/v4/core").$strip>], "state">;
127
- 400: import("zod").ZodObject<{
128
- message: import("zod").ZodString;
129
- code: import("zod").ZodString;
130
- errorCode: import("zod").ZodString;
131
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
132
- }, import("zod/v4/core").$strip>;
133
- 401: import("zod").ZodObject<{
134
- message: import("zod").ZodString;
135
- code: import("zod").ZodString;
136
- errorCode: import("zod").ZodString;
137
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
138
- }, import("zod/v4/core").$strip>;
139
- 404: import("zod").ZodObject<{
140
- message: import("zod").ZodString;
141
- code: import("zod").ZodString;
142
- errorCode: import("zod").ZodString;
143
- details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
144
- }, import("zod/v4/core").$strip>;
145
- }>;
@@ -1,53 +0,0 @@
1
- import { buildGetRoute } from '@lokalise/api-contracts';
2
- import { previewSiteResponseBody, previewTargetsRequestQueryString, previewTargetsResponseBody, } from '@lokalise/connector-api-contracts';
3
- import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA_V2, } from '../commonRequestSchemas.js';
4
- import { INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA } from './integrationPreviewSchemas.js';
5
- /**
6
- * Contract for resolving the connected site and its staging origin for in-context preview
7
- * GET /v1/integrations/{integrationId}/preview-site
8
- *
9
- * Proxies the connector's `GET /v1/preview-site` with the integration's stored auth.
10
- * The response is the connector contract's typed `available` / `unavailable` state;
11
- * connectors without preview support answer 400 `PREVIEW_NOT_SUPPORTED`.
12
- *
13
- * Accepts service-to-service tokens (the preview proxy) as well as user tokens
14
- * with access to the integration.
15
- */
16
- export const getIntegrationPreviewSiteContract = buildGetRoute({
17
- visibility: 'internal',
18
- pathResolver: (params) => `/v1/integrations/${params.integrationId}/preview-site`,
19
- description: 'Resolve the connected site and its HTTPS staging origin for in-context preview',
20
- requestPathParamsSchema: INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA,
21
- successResponseBodySchema: previewSiteResponseBody,
22
- responseSchemasByStatusCode: {
23
- 200: previewSiteResponseBody,
24
- 400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
25
- 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
26
- 404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
27
- },
28
- requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
29
- });
30
- /**
31
- * Contract for resolving the pages that render an item, for in-context preview
32
- * GET /v1/integrations/{integrationId}/preview-targets?itemId=
33
- *
34
- * `itemId` is the connector item identifier (`ItemIdentifier.groupId`), which
35
- * autopilot stores as the content item `sourceId`. Paths are relative to the
36
- * staging origin returned by the preview-site endpoint.
37
- */
38
- export const getIntegrationPreviewTargetsContract = buildGetRoute({
39
- visibility: 'internal',
40
- pathResolver: (params) => `/v1/integrations/${params.integrationId}/preview-targets`,
41
- description: 'Resolve the pages that render an item as paths under the staging origin',
42
- requestPathParamsSchema: INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA,
43
- requestQuerySchema: previewTargetsRequestQueryString,
44
- successResponseBodySchema: previewTargetsResponseBody,
45
- responseSchemasByStatusCode: {
46
- 200: previewTargetsResponseBody,
47
- 400: COMMON_ERROR_RESPONSE_SCHEMA_V2,
48
- 401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
49
- 404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
50
- },
51
- requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
52
- });
53
- //# sourceMappingURL=integrationPreviewApiSchemas.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"integrationPreviewApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/preview/integrationPreviewApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,uBAAuB,EACvB,gCAAgC,EAChC,0BAA0B,GAC3B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,sCAAsC,EAAE,MAAM,gCAAgC,CAAA;AAEvF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,aAAa,CAAC;IAC7D,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,eAAe;IACjF,WAAW,EAAE,gFAAgF;IAC7F,uBAAuB,EAAE,sCAAsC;IAC/D,yBAAyB,EAAE,uBAAuB;IAClD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,uBAAuB;QAC5B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oCAAoC,GAAG,aAAa,CAAC;IAChE,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,kBAAkB;IACpF,WAAW,EAAE,yEAAyE;IACtF,uBAAuB,EAAE,sCAAsC;IAC/D,kBAAkB,EAAE,gCAAgC;IACpD,yBAAyB,EAAE,0BAA0B;IACrD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,0BAA0B;QAC/B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
@@ -1,13 +0,0 @@
1
- import type { PreviewSiteResponseBody, PreviewTargetsRequestQueryString, PreviewTargetsResponseBody } from '@lokalise/connector-api-contracts';
2
- import { z } from 'zod/v4';
3
- /**
4
- * Path parameters for the integration preview endpoints
5
- */
6
- export declare const INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA: z.ZodObject<{
7
- integrationId: z.ZodGUID;
8
- }, z.core.$strip>;
9
- export type IntegrationPreviewPathParams = z.infer<typeof INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA>;
10
- /**
11
- * Re-export types from connector-api-contracts for convenience
12
- */
13
- export type { PreviewSiteResponseBody, PreviewTargetsRequestQueryString, PreviewTargetsResponseBody, };
@@ -1,8 +0,0 @@
1
- import { z } from 'zod/v4';
2
- /**
3
- * Path parameters for the integration preview endpoints
4
- */
5
- export const INTEGRATION_PREVIEW_PATH_PARAMS_SCHEMA = z.object({
6
- integrationId: z.guid(),
7
- });
8
- //# sourceMappingURL=integrationPreviewSchemas.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"integrationPreviewSchemas.js","sourceRoot":"","sources":["../../../src/schemas/preview/integrationPreviewSchemas.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B;;GAEG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7D,aAAa,EAAE,CAAC,CAAC,IAAI,EAAE;CACxB,CAAC,CAAA"}