@lokalise/connector-shell 2.3.0 → 2.4.0

package/README.md

@@ -1,5 +1,5 @@
 # @lokalise/connector-shell
-
+    
 A drop-in module for [opinionated-machine](https://github.com/lokalise/opinionated-machine) services that provides the connector shell infrastructure for Lokalise Content Engine connectors.
 
 This package provides the generic connector shell with all standard controllers (Auth, Cache, Env, ItemList, ItemGroup, Publish, Translate) and routing logic. It's designed to work with any set of adapters through automatic adapter discovery via dependency injection tags.

package/dist/env/envController.d.ts

@@ -23,6 +23,15 @@ export declare class EnvController extends AbstractController<EnvControllerContr
             metadataFields: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
                 type: import("zod").ZodEnum<{
                     FOLDER_HIERARCHY: "FOLDER_HIERARCHY";
+                    TAGS: "TAGS";
+                }>;
+            }, import("zod/v4/core").$strip>>>;
+            fieldDefinitions: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                id: import("zod").ZodString;
+                title: import("zod").ZodString;
+                type: import("zod").ZodEnum<{
+                    STRING: "STRING";
+                    DATE: "DATE";
                 }>;
             }, import("zod/v4/core").$strip>>>;
         }, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
@@ -51,6 +60,15 @@ export declare class EnvController extends AbstractController<EnvControllerContr
                 metadataFields: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
                     type: import("zod").ZodEnum<{
                         FOLDER_HIERARCHY: "FOLDER_HIERARCHY";
+                        TAGS: "TAGS";
+                    }>;
+                }, import("zod/v4/core").$strip>>>;
+                fieldDefinitions: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    title: import("zod").ZodString;
+                    type: import("zod").ZodEnum<{
+                        STRING: "STRING";
+                        DATE: "DATE";
                     }>;
                 }, import("zod/v4/core").$strip>>>;
             }, import("zod/v4/core").$strip>;

package/dist/env/envController.js

@@ -20,10 +20,12 @@ export class EnvController extends AbstractController {
             const localeData = await adapter.envService.getLocales(req.integrationConfig, req.authConfig, req.reqContext, req.query.defaultLocale);
             const cacheItemStructure = await adapter.envService.getCacheItemStructure(req.integrationConfig, req.authConfig, req.reqContext);
             const metadataFields = (await adapter.envService.getMetadataFields?.()) ?? {};
+            const fieldDefinitions = (await adapter.envService.getFieldDefinitions?.()) ?? [];
             await reply.send({
                 ...localeData,
                 cacheItemStructure,
                 metadataFields,
+                fieldDefinitions,
             });
         }, this.protectedRouteMetadataMapper());
     }

package/dist/env/envController.js.map

@@ -1 +1 @@
-{"version":3,"file":"envController.js","sourceRoot":"","sources":["../../src/env/envController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvF,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAA8B,MAAM,qBAAqB,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAKrE,OAAO,mBAAmB,CAAA;AAI1B,MAAM,OAAO,aAAc,SAAQ,kBAA8C;IACxE,MAAM,CAAC,SAAS,GAAG;QACxB,MAAM,EAAE,cAAc;KACd,CAAA;IAEO,QAAQ,CAAyB;IACjC,4BAA4B,CAAqC;IAElF,YAAY,YAAwC;QAClD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;QACrC,IAAI,CAAC,4BAA4B,GAAG,YAAY,CAAC,mCAAmC,CAAA;IACtF,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,0BAA0B,CAC/B,cAAc,EACd,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAA;YAC/E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,UAAU,CACpD,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,KAAK,CAAC,aAAa,CACxB,CAAA;YAED,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,qBAAqB,CACvE,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,UAAU,CACf,CAAA;YAED,MAAM,cAAc,GAAG,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;YAE7E,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,GAAG,UAAU;gBACb,kBAAkB;gBAClB,cAAc;aACf,CAAC,CAAA;QACJ,CAAC,EACD,IAAI,CAAC,4BAA4B,EAAE,CACpC,CAAA;IACH,CAAC;IAED,WAAW;QACT,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;SACiC,CAAA;IACxD,CAAC"}
+{"version":3,"file":"envController.js","sourceRoot":"","sources":["../../src/env/envController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AACvF,OAAO,EAAE,0BAA0B,EAAE,MAAM,iCAAiC,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAA8B,MAAM,qBAAqB,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAKrE,OAAO,mBAAmB,CAAA;AAI1B,MAAM,OAAO,aAAc,SAAQ,kBAA8C;IACxE,MAAM,CAAC,SAAS,GAAG;QACxB,MAAM,EAAE,cAAc;KACd,CAAA;IAEO,QAAQ,CAAyB;IACjC,4BAA4B,CAAqC;IAElF,YAAY,YAAwC;QAClD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;QACrC,IAAI,CAAC,4BAA4B,GAAG,YAAY,CAAC,mCAAmC,CAAA;IACtF,CAAC;IAED,IAAY,MAAM;QAChB,OAAO,0BAA0B,CAC/B,cAAc,EACd,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAA;YAC/E,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,UAAU,CACpD,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,KAAK,CAAC,aAAa,CACxB,CAAA;YAED,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,qBAAqB,CACvE,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,UAAU,CACf,CAAA;YAED,MAAM,cAAc,GAAG,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;YAE7E,MAAM,gBAAgB,GAAG,CAAC,MAAM,OAAO,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAA;YAEjF,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,GAAG,UAAU;gBACb,kBAAkB;gBAClB,cAAc;gBACd,gBAAgB;aACjB,CAAC,CAAA;QACJ,CAAC,EACD,IAAI,CAAC,4BAA4B,EAAE,CACpC,CAAA;IACH,CAAC;IAED,WAAW;QACT,OAAO;YACL,MAAM,EAAE,IAAI,CAAC,MAAM;SACiC,CAAA;IACxD,CAAC"}

package/dist/publish/publishController.d.ts

@@ -10,8 +10,25 @@ export declare class PublishController extends AbstractController<PublishControl
                 groupId: import("zod").ZodString;
                 metadata: import("zod").ZodRecord<import("zod").ZodAny, import("zod").ZodAny>;
                 translations: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>;
+                translatedSource: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"inline">;
+                    value: import("zod").ZodString;
+                    storageId: import("zod").ZodOptional<import("zod").ZodNever>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"remote">;
+                    storageId: import("zod").ZodString;
+                    contentSize: import("zod").ZodOptional<import("zod").ZodString>;
+                    filePath: import("zod").ZodOptional<import("zod").ZodString>;
+                    value: import("zod").ZodOptional<import("zod").ZodNever>;
+                }, import("zod/v4/core").$strip>]>>;
             }, import("zod/v4/core").$strip>>;
             defaultLocale: import("zod").ZodString;
+            exportOptions: import("zod").ZodOptional<import("zod").ZodObject<{
+                languageFolders: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    slug: import("zod").ZodString;
+                }, import("zod/v4/core").$strip>>>;
+            }, import("zod/v4/core").$strip>>;
         }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
             statusCode: import("zod").ZodNumber;
             message: import("zod").ZodOptional<import("zod").ZodString>;

package/dist/publish/publishController.js

@@ -18,7 +18,7 @@ export class PublishController extends AbstractController {
     get postPublishContent() {
         return buildFastifyPayloadRoute(postPublishContract, async (req, reply) => {
             const adapter = resolveAdapter(this.adapters, req.headers[CONNECTOR_ID_HEADER]);
-            const publishResult = await adapter.publishService.publishContent(req.integrationConfig, req.authConfig, req.body.items, req.body.defaultLocale, req.reqContext);
+            const publishResult = await adapter.publishService.publishContent(req.integrationConfig, req.authConfig, req.body.items, req.body.defaultLocale, req.reqContext, req.body.exportOptions ?? {});
             if (publishResult.error) {
                 throw new PublicNonRecoverableError({
                     message: 'Could not publish content',

package/dist/publish/publishController.js.map

@@ -1 +1 @@
-{"version":3,"file":"publishController.js","sourceRoot":"","sources":["../../src/publish/publishController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC1E,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AACtF,OAAO,EAAE,kBAAkB,EAA8B,MAAM,qBAAqB,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAKrE,OAAO,mBAAmB,CAAA;AAI1B,MAAM,OAAO,iBAAkB,SAAQ,kBAAkD;IAChF,MAAM,CAAC,SAAS,GAAG;QACxB,WAAW,EAAE,mBAAmB;KACxB,CAAA;IACO,QAAQ,CAAyB;IACjC,4BAA4B,CAAqC;IAElF,YAAY,YAAwC;QAClD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;QACrC,IAAI,CAAC,4BAA4B,GAAG,YAAY,CAAC,mCAAmC,CAAA;IACtF,CAAC;IAED,IAAY,kBAAkB;QAC5B,OAAO,wBAAwB,CAC7B,mBAAmB,EACnB,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAA;YAC/E,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,cAAc,CAC/D,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,IAAI,CAAC,KAAK,EACd,GAAG,CAAC,IAAI,CAAC,aAAa,EACtB,GAAG,CAAC,UAAU,CACf,CAAA;YAED,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACxB,MAAM,IAAI,yBAAyB,CAAC;oBAClC,OAAO,EAAE,2BAA2B;oBACpC,cAAc,EAAE,GAAG;oBACnB,SAAS,EAAE,kBAAkB;oBAC7B,OAAO,EAAE;wBACP,sBAAsB,EAAE,aAAa,CAAC,KAAK;qBAC5C;iBACF,CAAC,CAAA;YACJ,CAAC;YAED,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CACzB;gBACE,aAAa,EAAE,qBAAqB,CAAC,aAAa,CAAC;aACpD,EACD,yBAAyB,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAC9D,CAAA;YAED,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,8BAA8B;aACxC,CAAC,CAAA;QACJ,CAAC,EACD,IAAI,CAAC,4BAA4B,EAAE,CACpC,CAAA;IACH,CAAC;IAED,WAAW;QACT,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,kBAAkB;SACrC,CAAA;IACH,CAAC"}
+{"version":3,"file":"publishController.js","sourceRoot":"","sources":["../../src/publish/publishController.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AAC5F,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC1E,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAA;AACtF,OAAO,EAAE,kBAAkB,EAA8B,MAAM,qBAAqB,CAAA;AACpF,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAA;AAKrE,OAAO,mBAAmB,CAAA;AAI1B,MAAM,OAAO,iBAAkB,SAAQ,kBAAkD;IAChF,MAAM,CAAC,SAAS,GAAG;QACxB,WAAW,EAAE,mBAAmB;KACxB,CAAA;IACO,QAAQ,CAAyB;IACjC,4BAA4B,CAAqC;IAElF,YAAY,YAAwC;QAClD,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC,QAAQ,CAAA;QACrC,IAAI,CAAC,4BAA4B,GAAG,YAAY,CAAC,mCAAmC,CAAA;IACtF,CAAC;IAED,IAAY,kBAAkB;QAC5B,OAAO,wBAAwB,CAC7B,mBAAmB,EACnB,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACnB,MAAM,OAAO,GAAG,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAA;YAC/E,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,cAAc,CAC/D,GAAG,CAAC,iBAAiB,EACrB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,IAAI,CAAC,KAAK,EACd,GAAG,CAAC,IAAI,CAAC,aAAa,EACtB,GAAG,CAAC,UAAU,EACd,GAAG,CAAC,IAAI,CAAC,aAAa,IAAI,EAAE,CAC7B,CAAA;YAED,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;gBACxB,MAAM,IAAI,yBAAyB,CAAC;oBAClC,OAAO,EAAE,2BAA2B;oBACpC,cAAc,EAAE,GAAG;oBACnB,SAAS,EAAE,kBAAkB;oBAC7B,OAAO,EAAE;wBACP,sBAAsB,EAAE,aAAa,CAAC,KAAK;qBAC5C;iBACF,CAAC,CAAA;YACJ,CAAC;YAED,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CACzB;gBACE,aAAa,EAAE,qBAAqB,CAAC,aAAa,CAAC;aACpD,EACD,yBAAyB,OAAO,CAAC,gBAAgB,EAAE,UAAU,CAC9D,CAAA;YAED,MAAM,KAAK,CAAC,IAAI,CAAC;gBACf,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE,8BAA8B;aACxC,CAAC,CAAA;QACJ,CAAC,EACD,IAAI,CAAC,4BAA4B,EAAE,CACpC,CAAA;IACH,CAAC;IAED,WAAW;QACT,OAAO;YACL,WAAW,EAAE,IAAI,CAAC,kBAAkB;SACrC,CAAA;IACH,CAAC"}

package/dist/translate/translateController.d.ts

@@ -21,12 +21,24 @@ export declare class TranslateController extends AbstractController<TranslateCon
                 groupId: import("zod").ZodString;
                 metadata: import("zod").ZodRecord<import("zod").ZodAny, import("zod").ZodAny>;
                 translations: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>;
+                translatedSource: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"inline">;
+                    value: import("zod").ZodString;
+                    storageId: import("zod").ZodOptional<import("zod").ZodNever>;
+                }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                    type: import("zod").ZodLiteral<"remote">;
+                    storageId: import("zod").ZodString;
+                    contentSize: import("zod").ZodOptional<import("zod").ZodString>;
+                    filePath: import("zod").ZodOptional<import("zod").ZodString>;
+                    value: import("zod").ZodOptional<import("zod").ZodNever>;
+                }, import("zod/v4/core").$strip>]>>;
                 itemGroups: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                     id: import("zod").ZodString;
                     name: import("zod").ZodString;
                     parentItemGroupId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
                     details: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
                 }, import("zod/v4/core").$strip>>>;
+                tags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
             }, import("zod/v4/core").$strip>>;
             payload: import("zod").ZodOptional<import("zod").ZodObject<{
                 message: import("zod").ZodString;
@@ -50,12 +62,24 @@ export declare class TranslateController extends AbstractController<TranslateCon
                     groupId: import("zod").ZodString;
                     metadata: import("zod").ZodRecord<import("zod").ZodAny, import("zod").ZodAny>;
                     translations: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>;
+                    translatedSource: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"inline">;
+                        value: import("zod").ZodString;
+                        storageId: import("zod").ZodOptional<import("zod").ZodNever>;
+                    }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                        type: import("zod").ZodLiteral<"remote">;
+                        storageId: import("zod").ZodString;
+                        contentSize: import("zod").ZodOptional<import("zod").ZodString>;
+                        filePath: import("zod").ZodOptional<import("zod").ZodString>;
+                        value: import("zod").ZodOptional<import("zod").ZodNever>;
+                    }, import("zod/v4/core").$strip>]>>;
                     itemGroups: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
                         id: import("zod").ZodString;
                         name: import("zod").ZodString;
                         parentItemGroupId: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
                         details: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>;
                     }, import("zod/v4/core").$strip>>>;
+                    tags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
                 }, import("zod/v4/core").$strip>>;
                 payload: import("zod").ZodOptional<import("zod").ZodObject<{
                     message: import("zod").ZodString;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/connector-shell",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "type": "module",
     "private": false,
     "publishConfig": {
@@ -35,6 +35,10 @@
         "content-engine"
     ],
     "author": "Lokalise",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/lokalise/composed-connector.git"
+    },
     "dependencies": {
         "@lokalise/connector-adapter-common": "*",
         "@lokalise/fastify-api-contracts": "^5.3.0",
@@ -44,15 +48,15 @@
         "opinionated-machine": "^5.2.0"
     },
     "peerDependencies": {
-        "@lokalise/connector-api-contracts": "^1.33.0",
+        "@lokalise/connector-api-contracts": "^1.44.0",
         "zod": "^4.1.12",
         "fastify": "^5.6.2"
     },
     "devDependencies": {
-        "@biomejs/biome": "^2.3.8",
+        "@biomejs/biome": "^2.4.6",
         "@lokalise/biome-config": "^3.1.1",
         "@lokalise/tsconfig": "^3.1.0",
-        "@types/node": "^25.3.3",
+        "@types/node": "^25.4.0",
         "@vitest/coverage-v8": "^3.2.4",
         "typescript": "^5.9.3",
         "vitest": "^3.2.4"