@lokalise/content-type-app-engine-contracts 2.14.3 → 2.19.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 (7) hide show
  1. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.d.ts +24 -2
  2. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js +23 -1
  3. package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js.map +1 -1
  4. package/dist/schemas/itemList/integrationItemListApiSchemas.d.ts +29 -6
  5. package/dist/schemas/itemList/integrationItemListApiSchemas.js +28 -3
  6. package/dist/schemas/itemList/integrationItemListApiSchemas.js.map +1 -1
  7. package/package.json +1 -1
package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.d.ts CHANGED
@@ -5,7 +5,29 @@
5
5
  * Query Parameters (from connector-api-contracts):
6
6
  * - limit: Maximum number of item groups to return
7
7
  * - cursor: Pagination cursor
8
- * - parentItemGroupId: Parent group ID for hierarchical navigation
8
+ * - $filter: OData filter expression for flexible filtering
9
+ *
10
+ * ## OData $filter Examples
11
+ *
12
+ * Get children of a specific folder:
13
+ * ```
14
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq 'folder-123'
15
+ * ```
16
+ *
17
+ * Get root-level groups only:
18
+ * ```
19
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq null
20
+ * ```
21
+ *
22
+ * Filter by group type:
23
+ * ```
24
+ * GET /v1/integrations/{id}/item-groups?$filter=type eq 'folder'
25
+ * ```
26
+ *
27
+ * Combined filters
28
+ * ```
29
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq 'folder-123' and type eq 'folder'
30
+ * ```
9
31
  */
10
32
  export declare const getIntegrationItemGroupsContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod/v4").ZodObject<{
11
33
  items: import("zod/v4").ZodArray<import("zod/v4").ZodObject<{
@@ -21,7 +43,7 @@ export declare const getIntegrationItemGroupsContract: import("@lokalise/api-con
21
43
  }, import("zod/v4/core").$strip>, import("zod/v4").ZodObject<{
22
44
  limit: import("zod/v4").ZodOptional<import("zod/v4").ZodCoercedNumber<unknown>>;
23
45
  cursor: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
24
- parentItemGroupId: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
46
+ $filter: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
25
47
  }, import("zod/v4/core").$strip>, import("zod/v4").ZodObject<{
26
48
  authorization: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
27
49
  }, import("zod/v4/core").$strip>, undefined, false, false, {
package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js CHANGED
@@ -9,7 +9,29 @@ import { GET_INTEGRATION_ITEM_GROUPS_PATH_PARAMS_SCHEMA } from "./integrationIte
9
9
  * Query Parameters (from connector-api-contracts):
10
10
  * - limit: Maximum number of item groups to return
11
11
  * - cursor: Pagination cursor
12
- * - parentItemGroupId: Parent group ID for hierarchical navigation
12
+ * - $filter: OData filter expression for flexible filtering
13
+ *
14
+ * ## OData $filter Examples
15
+ *
16
+ * Get children of a specific folder:
17
+ * ```
18
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq 'folder-123'
19
+ * ```
20
+ *
21
+ * Get root-level groups only:
22
+ * ```
23
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq null
24
+ * ```
25
+ *
26
+ * Filter by group type:
27
+ * ```
28
+ * GET /v1/integrations/{id}/item-groups?$filter=type eq 'folder'
29
+ * ```
30
+ *
31
+ * Combined filters
32
+ * ```
33
+ * GET /v1/integrations/{id}/item-groups?$filter=parentItemGroupId eq 'folder-123' and type eq 'folder'
34
+ * ```
13
35
  */
14
36
  export const getIntegrationItemGroupsContract = buildGetRoute({
15
37
  pathResolver: (params) => `/v1/integrations/${params.integrationId}/item-groups`,
package/dist/schemas/itemGroup/integrationItemGroupApiSchemas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"integrationItemGroupApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/itemGroup/integrationItemGroupApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,+BAA+B,EAC/B,yBAAyB,GAC1B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,8CAA8C,EAAE,MAAM,kCAAkC,CAAA;AAEjG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,aAAa,CAAC;IAC5D,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,cAAc;IAChF,WAAW,EAAE,2DAA2D;IACxE,uBAAuB,EAAE,8CAA8C;IACvE,kBAAkB,EAAE,+BAA+B;IACnD,yBAAyB,EAAE,yBAAyB;IACpD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,yBAAyB;QAC9B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
1
+ {"version":3,"file":"integrationItemGroupApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/itemGroup/integrationItemGroupApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,+BAA+B,EAC/B,yBAAyB,GAC1B,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,8CAA8C,EAAE,MAAM,kCAAkC,CAAA;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,aAAa,CAAC;IAC5D,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,cAAc;IAChF,WAAW,EAAE,2DAA2D;IACxE,uBAAuB,EAAE,8CAA8C;IACvE,kBAAkB,EAAE,+BAA+B;IACnD,yBAAyB,EAAE,yBAAyB;IACpD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,yBAAyB;QAC9B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
package/dist/schemas/itemList/integrationItemListApiSchemas.d.ts CHANGED
@@ -5,9 +5,34 @@
5
5
  * Query Parameters (from connector-api-contracts):
6
6
  * - limit: Maximum number of items to return
7
7
  * - cursor: Pagination cursor
8
- * - contentTypes: Filter by content types (array)
9
- * - filterByGroups: Filter by group IDs (array)
10
- * - filter: Generic key-value filters (e.g., lastModifiedAt, ownedBy)
8
+ * - $filter: OData filter expression for flexible filtering
9
+ *
10
+ * ## OData $filter Examples
11
+ *
12
+ * Filter by owner:
13
+ * ```
14
+ * GET /v1/integrations/{id}/items?$filter=ownedBy eq 'me'
15
+ * ```
16
+ *
17
+ * Filter by modified date:
18
+ * ```
19
+ * GET /v1/integrations/{id}/items?$filter=modifiedTime gt 2024-11-01
20
+ * ```
21
+ *
22
+ * Filter by multiple folders:
23
+ * ```
24
+ * GET /v1/integrations/{id}/items?$filter=parentGroup in ('folder-a', 'folder-b')
25
+ * ```
26
+ *
27
+ * Complex filter with AND/OR:
28
+ * ```
29
+ * GET /v1/integrations/{id}/items?$filter=(ownedBy eq 'me' or sharedWithMe eq true) and modifiedTime gt 2024-11-01
30
+ * ```
31
+ *
32
+ * Search by name:
33
+ * ```
34
+ * GET /v1/integrations/{id}/items?$filter=contains(name, 'report')
35
+ * ```
11
36
  */
12
37
  export declare const getIntegrationItemsContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod/v4").ZodObject<{
13
38
  data: import("zod/v4").ZodArray<import("zod/v4").ZodObject<{
@@ -28,9 +53,7 @@ export declare const getIntegrationItemsContract: import("@lokalise/api-contract
28
53
  }, import("zod/v4/core").$strip>, import("zod/v4").ZodObject<{
29
54
  limit: import("zod/v4").ZodOptional<import("zod/v4").ZodCoercedNumber<unknown>>;
30
55
  cursor: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
31
- contentTypes: import("zod/v4").ZodOptional<import("zod/v4").ZodPipe<import("zod/v4").ZodTransform<unknown, unknown>, import("zod/v4").ZodArray<import("zod/v4").ZodString>>>;
32
- filterByGroups: import("zod/v4").ZodOptional<import("zod/v4").ZodPipe<import("zod/v4").ZodTransform<unknown, unknown>, import("zod/v4").ZodArray<import("zod/v4").ZodString>>>;
33
- filter: import("zod/v4").ZodOptional<import("zod/v4").ZodRecord<import("zod/v4").ZodString, import("zod/v4").ZodAny>>;
56
+ $filter: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
34
57
  }, import("zod/v4/core").$strip>, import("zod/v4").ZodObject<{
35
58
  authorization: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
36
59
  }, import("zod/v4/core").$strip>, undefined, false, false, {
package/dist/schemas/itemList/integrationItemListApiSchemas.js CHANGED
@@ -9,9 +9,34 @@ import { GET_INTEGRATION_ITEMS_PATH_PARAMS_SCHEMA } from "./integrationItemListS
9
9
  * Query Parameters (from connector-api-contracts):
10
10
  * - limit: Maximum number of items to return
11
11
  * - cursor: Pagination cursor
12
- * - contentTypes: Filter by content types (array)
13
- * - filterByGroups: Filter by group IDs (array)
14
- * - filter: Generic key-value filters (e.g., lastModifiedAt, ownedBy)
12
+ * - $filter: OData filter expression for flexible filtering
13
+ *
14
+ * ## OData $filter Examples
15
+ *
16
+ * Filter by owner:
17
+ * ```
18
+ * GET /v1/integrations/{id}/items?$filter=ownedBy eq 'me'
19
+ * ```
20
+ *
21
+ * Filter by modified date:
22
+ * ```
23
+ * GET /v1/integrations/{id}/items?$filter=modifiedTime gt 2024-11-01
24
+ * ```
25
+ *
26
+ * Filter by multiple folders:
27
+ * ```
28
+ * GET /v1/integrations/{id}/items?$filter=parentGroup in ('folder-a', 'folder-b')
29
+ * ```
30
+ *
31
+ * Complex filter with AND/OR:
32
+ * ```
33
+ * GET /v1/integrations/{id}/items?$filter=(ownedBy eq 'me' or sharedWithMe eq true) and modifiedTime gt 2024-11-01
34
+ * ```
35
+ *
36
+ * Search by name:
37
+ * ```
38
+ * GET /v1/integrations/{id}/items?$filter=contains(name, 'report')
39
+ * ```
15
40
  */
16
41
  export const getIntegrationItemsContract = buildGetRoute({
17
42
  pathResolver: (params) => `/v1/integrations/${params.integrationId}/items`,
package/dist/schemas/itemList/integrationItemListApiSchemas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"integrationItemListApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/itemList/integrationItemListApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACpG,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,wCAAwC,EAAE,MAAM,iCAAiC,CAAA;AAE1F;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,aAAa,CAAC;IACvD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,QAAQ;IAC1E,WAAW,EAAE,oDAAoD;IACjE,uBAAuB,EAAE,wCAAwC;IACjE,kBAAkB,EAAE,0BAA0B;IAC9C,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
1
+ {"version":3,"file":"integrationItemListApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/itemList/integrationItemListApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,0BAA0B,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAA;AACpG,OAAO,EACL,2BAA2B,EAC3B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,wCAAwC,EAAE,MAAM,iCAAiC,CAAA;AAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,aAAa,CAAC;IACvD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,MAAM,CAAC,aAAa,QAAQ;IAC1E,WAAW,EAAE,oDAAoD;IACjE,uBAAuB,EAAE,wCAAwC;IACjE,kBAAkB,EAAE,0BAA0B;IAC9C,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/content-type-app-engine-contracts",
3
- "version": "2.14.3",
3
+ "version": "2.19.0",
4
4
  "description": "Content Type App Engine service contracts",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",