@owox/backend 0.38.0 → 0.39.0

package/dist/src/plugin-host/utils/plugin-manifest.util.d.ts

@@ -69,16 +69,59 @@ export declare const PluginCredentialRequirementSchema: z.ZodUnion<[z.ZodString,
     id: z.ZodString;
     optional: z.ZodDefault<z.ZodBoolean>;
     models: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    scopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     optional: boolean;
+    scopes?: string[] | undefined;
     models?: string[] | undefined;
 }, {
     id: string;
+    scopes?: string[] | undefined;
     models?: string[] | undefined;
     optional?: boolean | undefined;
 }>]>;
 export type PluginCredentialRequirement = z.infer<typeof PluginCredentialRequirementSchema>;
+export declare const PLUGIN_ACTION_NAME_PATTERN: RegExp;
+export declare const PluginBackendSchema: z.ZodObject<{
+    url: z.ZodString;
+    actions: z.ZodEffects<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodObject<{
+        timeoutSeconds: z.ZodDefault<z.ZodNumber>;
+        input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        timeoutSeconds: number;
+        input?: Record<string, unknown> | undefined;
+    }, {
+        input?: Record<string, unknown> | undefined;
+        timeoutSeconds?: number | undefined;
+    }>>, Record<string, {
+        timeoutSeconds: number;
+        input?: Record<string, unknown> | undefined;
+    }>, Record<string, {
+        input?: Record<string, unknown> | undefined;
+        timeoutSeconds?: number | undefined;
+    }>>, Record<string, {
+        timeoutSeconds: number;
+        input?: Record<string, unknown> | undefined;
+    }>, Record<string, {
+        input?: Record<string, unknown> | undefined;
+        timeoutSeconds?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    actions: Record<string, {
+        timeoutSeconds: number;
+        input?: Record<string, unknown> | undefined;
+    }>;
+}, {
+    url: string;
+    actions: Record<string, {
+        input?: Record<string, unknown> | undefined;
+        timeoutSeconds?: number | undefined;
+    }>;
+}>;
+export type PluginBackendDeclaration = z.infer<typeof PluginBackendSchema>;
+export type PluginBackendActionDeclaration = PluginBackendDeclaration['actions'][string];
 export type PluginCollectionDeclaration = z.infer<typeof PluginCollectionDeclarationSchema>;
 export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
     name: z.ZodString;
@@ -160,21 +203,62 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
         id: z.ZodString;
         optional: z.ZodDefault<z.ZodBoolean>;
         models: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        scopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         optional: boolean;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
     }, {
         id: string;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
         optional?: boolean | undefined;
     }>]>, "many">>;
+    backend: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        actions: z.ZodEffects<z.ZodEffects<z.ZodRecord<z.ZodString, z.ZodObject<{
+            timeoutSeconds: z.ZodDefault<z.ZodNumber>;
+            input: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        }, "strip", z.ZodTypeAny, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>>, Record<string, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }>, Record<string, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>>, Record<string, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }>, Record<string, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        actions: Record<string, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }>;
+    }, {
+        url: string;
+        actions: Record<string, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     description: string;
     credentials: (string | {
         id: string;
         optional: boolean;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
     })[];
     delivery: {
@@ -194,6 +278,13 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
             };
         } | undefined;
     }[];
+    backend?: {
+        url: string;
+        actions: Record<string, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }>;
+    } | undefined;
 }, {
     name: string;
     description: string;
@@ -203,6 +294,7 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
     };
     credentials?: (string | {
         id: string;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
         optional?: boolean | undefined;
     })[] | undefined;
@@ -219,12 +311,20 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
             };
         } | undefined;
     }[] | undefined;
+    backend?: {
+        url: string;
+        actions: Record<string, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>;
+    } | undefined;
 }>, {
     name: string;
     description: string;
     credentials: (string | {
         id: string;
         optional: boolean;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
     })[];
     delivery: {
@@ -244,6 +344,13 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
             };
         } | undefined;
     }[];
+    backend?: {
+        url: string;
+        actions: Record<string, {
+            timeoutSeconds: number;
+            input?: Record<string, unknown> | undefined;
+        }>;
+    } | undefined;
 }, {
     name: string;
     description: string;
@@ -253,6 +360,7 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
     };
     credentials?: (string | {
         id: string;
+        scopes?: string[] | undefined;
         models?: string[] | undefined;
         optional?: boolean | undefined;
     })[] | undefined;
@@ -269,6 +377,13 @@ export declare const PluginManifestSchema: z.ZodEffects<z.ZodObject<{
             };
         } | undefined;
     }[] | undefined;
+    backend?: {
+        url: string;
+        actions: Record<string, {
+            input?: Record<string, unknown> | undefined;
+            timeoutSeconds?: number | undefined;
+        }>;
+    } | undefined;
 }>;
 export type PluginManifest = z.infer<typeof PluginManifestSchema>;
 export type ManifestParseResult = {
@@ -279,6 +394,12 @@ export type ManifestParseResult = {
     readonly code: ReleaseRejectionCode;
     readonly detail: string;
 };
+export declare function listActionInputSchemas(backend: PluginBackendDeclaration | null | undefined): {
+    readonly path: string;
+    readonly schema: Record<string, unknown>;
+}[];
 export declare function parsePluginManifest(rawFileContent: string | null): ManifestParseResult;
 export declare function findIncompatibleCollectionChange(current: readonly PluginCollectionDeclaration[], candidate: readonly PluginCollectionDeclaration[]): string | null;
+export declare function resolveBackendUrl(backend: PluginBackendDeclaration, deliveryUrl: string): string;
+export declare function findIncompatibleActionChange(current: PluginBackendDeclaration | null | undefined, candidate: PluginBackendDeclaration | null | undefined): string | null;
 export {};

package/dist/src/plugin-host/utils/plugin-manifest.util.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginManifestSchema = exports.PluginCredentialRequirementSchema = exports.PluginCollectionActionSchema = exports.PluginCollectionEntityTypeSchema = void 0;
+exports.PluginManifestSchema = exports.PluginBackendSchema = exports.PLUGIN_ACTION_NAME_PATTERN = exports.PluginCredentialRequirementSchema = exports.PluginCollectionActionSchema = exports.PluginCollectionEntityTypeSchema = void 0;
+exports.listActionInputSchemas = listActionInputSchemas;
 exports.parsePluginManifest = parsePluginManifest;
 exports.findIncompatibleCollectionChange = findIncompatibleCollectionChange;
+exports.resolveBackendUrl = resolveBackendUrl;
+exports.findIncompatibleActionChange = findIncompatibleActionChange;
+const internal_helpers_1 = require("@owox/internal-helpers");
 const zod_1 = require("zod");
 const builtin_credential_definitions_1 = require("../../data-marts/credentials/services/builtin-credential-definitions");
+const plugin_action_limits_1 = require("../constants/plugin-action-limits");
 const release_rejection_code_enum_1 = require("../enums/release-rejection-code.enum");
+const action_input_schema_util_1 = require("./action-input-schema.util");
 exports.PluginCollectionEntityTypeSchema = zod_1.z.enum([
     'data-mart',
     'storage',
@@ -49,8 +55,22 @@ exports.PluginCredentialRequirementSchema = zod_1.z.union([
         id: zod_1.z.string().trim().min(1).max(255),
         optional: zod_1.z.boolean().default(false),
         models: zod_1.z.array(zod_1.z.string().trim().min(1).max(255)).max(20).optional(),
+        scopes: zod_1.z.array(zod_1.z.string().min(1).max(200).regex(/^\S+$/)).min(1).max(20).optional(),
     }),
 ]);
+exports.PLUGIN_ACTION_NAME_PATTERN = /^[a-z][a-z0-9-]{0,63}$/;
+exports.PluginBackendSchema = zod_1.z.object({
+    url: zod_1.z.string().min(1).max(2048),
+    actions: zod_1.z
+        .record(zod_1.z
+        .string()
+        .regex(exports.PLUGIN_ACTION_NAME_PATTERN, 'action names are lower-case letters, digits and hyphens, start with a letter, and have at most 64 characters'), zod_1.z.object({
+        timeoutSeconds: zod_1.z.number().int().min(1).max(300).default(30),
+        input: zod_1.z.record(zod_1.z.unknown()).optional(),
+    }))
+        .refine(actions => Object.keys(actions).length >= 1, 'declare at least one action')
+        .refine(actions => Object.keys(actions).length <= plugin_action_limits_1.PLUGIN_ACTION_LIMITS.maxActions, `at most ${plugin_action_limits_1.PLUGIN_ACTION_LIMITS.maxActions} actions`),
+});
 const ENTITY_ACTIONS = {
     'data-mart': new Set([
         'SEE',
@@ -91,6 +111,7 @@ exports.PluginManifestSchema = zod_1.z
     }),
     collections: zod_1.z.array(PluginCollectionDeclarationSchema).max(50).default([]),
     credentials: zod_1.z.array(exports.PluginCredentialRequirementSchema).max(50).default([]),
+    backend: exports.PluginBackendSchema.optional(),
 })
     .superRefine((manifest, context) => {
     const names = new Set();
@@ -164,11 +185,84 @@ exports.PluginManifestSchema = zod_1.z
                 message: 'models are supported only for the logical ai requirement',
             });
         }
+        const scopes = typeof requirement === 'string' ? undefined : requirement.scopes;
+        if (key === 'google-service-account' && !scopes) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                path: ['credentials', index],
+                message: 'google-service-account requires scopes',
+            });
+        }
+        if (key !== 'google-service-account' && scopes) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                path: ['credentials', index, 'scopes'],
+                message: 'scopes are supported only for google-service-account',
+            });
+        }
+        if (scopes && new Set(scopes).size !== scopes.length) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                path: ['credentials', index, 'scopes'],
+                message: 'scopes must be unique',
+            });
+        }
+    }
+    if (manifest.backend) {
+        const problem = findBackendUrlProblem(manifest.backend.url, manifest.delivery.url);
+        if (problem) {
+            context.addIssue({
+                code: zod_1.z.ZodIssueCode.custom,
+                path: ['backend', 'url'],
+                message: problem,
+            });
+        }
     }
 });
 function isRecord(value) {
     return typeof value === 'object' && value !== null && !Array.isArray(value);
 }
+function parseUrl(value, base) {
+    try {
+        return new URL(value, base);
+    }
+    catch {
+        return null;
+    }
+}
+function findBackendUrlProblem(url, deliveryUrl) {
+    const absolute = /^[a-z][a-z0-9+.-]*:/i.test(url);
+    if (absolute && !(url.startsWith('https://') && parseUrl(url))) {
+        return 'an absolute URL must use https';
+    }
+    const delivery = parseUrl(deliveryUrl);
+    if (!delivery)
+        return null;
+    const resolved = parseUrl(url, deliveryUrl);
+    if (!absolute && resolved?.origin !== delivery.origin) {
+        return 'a relative URL must stay on the delivery.url origin';
+    }
+    return resolved?.username || resolved?.password
+        ? 'the URL must not contain a user name or password'
+        : null;
+}
+function listActionInputSchemas(backend) {
+    return Object.entries(backend?.actions ?? {}).flatMap(([name, action]) => action.input ? [{ path: `backend.actions.${name}.input`, schema: action.input }] : []);
+}
+function findUnsupportedActionInput(backend) {
+    for (const { path, schema } of listActionInputSchemas(backend)) {
+        try {
+            if (Buffer.byteLength(JSON.stringify(schema)) > plugin_action_limits_1.PLUGIN_ACTION_LIMITS.maxInputSchemaBytes) {
+                return `${path}: exceeds ${plugin_action_limits_1.PLUGIN_ACTION_LIMITS.maxInputSchemaBytes / 1024} KiB`;
+            }
+            (0, action_input_schema_util_1.assertBoundedSchema)(schema);
+        }
+        catch (error) {
+            return `${path}: ${(0, internal_helpers_1.castError)(error).message}`;
+        }
+    }
+    return null;
+}
 function parsePluginManifest(rawFileContent) {
     if (rawFileContent === null) {
         return {
@@ -213,6 +307,14 @@ function parsePluginManifest(rawFileContent) {
                 .join('; '),
         };
     }
+    const unsupportedInput = findUnsupportedActionInput(result.data.backend);
+    if (unsupportedInput) {
+        return {
+            ok: false,
+            code: release_rejection_code_enum_1.ReleaseRejectionCode.ACTION_INPUT_UNSUPPORTED,
+            detail: unsupportedInput,
+        };
+    }
     return { ok: true, manifest: result.data };
 }
 function findIncompatibleCollectionChange(current, candidate) {
@@ -233,4 +335,12 @@ function findIncompatibleCollectionChange(current, candidate) {
     }
     return null;
 }
+function resolveBackendUrl(backend, deliveryUrl) {
+    return new URL(backend.url, deliveryUrl).toString();
+}
+function findIncompatibleActionChange(current, candidate) {
+    const next = candidate?.actions ?? {};
+    const removed = Object.keys(current?.actions ?? {}).find(name => !Object.hasOwn(next, name));
+    return removed === undefined ? null : `Action "${removed}" cannot be removed`;
+}
 //# sourceMappingURL=plugin-manifest.util.js.map

package/dist/src/plugin-host/utils/request-abort-signal.util.d.ts

@@ -0,0 +1,5 @@
+import type { Request } from 'express';
+export declare function requestAbortSignal(request: Request): {
+    readonly signal: AbortSignal;
+    dispose(): void;
+};

package/dist/src/plugin-host/utils/request-abort-signal.util.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.requestAbortSignal = requestAbortSignal;
+function requestAbortSignal(request) {
+    const controller = new AbortController();
+    const abort = () => controller.abort();
+    request.once('aborted', abort);
+    request.res?.once('close', abort);
+    request.res?.once('error', abort);
+    return {
+        signal: controller.signal,
+        dispose: () => {
+            request.off('aborted', abort);
+            request.res?.off('close', abort);
+            request.res?.off('error', abort);
+        },
+    };
+}
+//# sourceMappingURL=request-abort-signal.util.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@owox/backend",
-  "version": "0.38.0",
+  "version": "0.39.0",
   "description": "OWOX Data Marts Backend - Full-stack data orchestration platform",
   "author": "OWOX",
   "license": "ELv2",
@@ -77,7 +77,7 @@
     "@google-cloud/opentelemetry-cloud-trace-exporter": "^3.0.0",
     "@google-cloud/pubsub": "^4.0.7",
     "@google-cloud/storage": "^7.21.0",
-    "@huggingface/transformers": "^3.0.0",
+    "@huggingface/transformers": "^4.3.1",
     "@modelcontextprotocol/node": "^2.0.0",
     "@modelcontextprotocol/server": "^2.0.0",
     "@nestjs/common": "^11.0.1",
@@ -92,17 +92,19 @@
     "@opentelemetry/exporter-trace-otlp-http": "^0.220.0",
     "@opentelemetry/sdk-trace-base": "^2.9.0",
     "@opentelemetry/sdk-trace-node": "^2.9.0",
-    "@owox/connectors": "0.38.0",
-    "@owox/idp-protocol": "0.38.0",
-    "@owox/internal-helpers": "0.38.0",
+    "@owox/connectors": "0.39.0",
+    "@owox/idp-protocol": "0.39.0",
+    "@owox/internal-helpers": "0.39.0",
+    "ajv": "^8.20.0",
     "better-sqlite3": "^12.2.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
-    "compression": "^1.8.1",
+    "compression": "^1.8.2",
     "cross-spawn": "^7.0.6",
     "env-paths": "^3.0.0",
+    "google-auth-library": "^10.9.1",
     "googleapis": "^150.0.1",
-    "handlebars": "^4.7.9",
+    "handlebars": "^4.7.10",
     "hono": "^4.11.4",
     "ipaddr.js": "^1.9.1",
     "jsonwebtoken": "^9.0.0",
@@ -119,7 +121,7 @@
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
     "rxjs": "^7.8.1",
-    "snowflake-sdk": "^2.3.3",
+    "snowflake-sdk": "^3.4.0",
     "swagger-ui-express": "^5.0.1",
     "typeorm": "^0.3.31",
     "typeorm-transactional": "^0.5.0",