@opra/core 0.0.11 → 0.0.13

package/cjs/constants.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RESOURCE_METADATA = exports.OpraVersion = void 0;
+exports.RESOLVER_METADATA = exports.RESOURCE_METADATA = exports.OpraVersion = void 0;
 exports.OpraVersion = '1.0';
 exports.RESOURCE_METADATA = 'opra:resource.metadata';
+exports.RESOLVER_METADATA = 'opra:resolver.metadata';

package/cjs/decorators/api-resolver.decorator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiResolver = void 0;
+const constants_js_1 = require("../constants.js");
+function ApiResolver(options) {
+    return (target, propertyKey) => {
+        const metadata = {
+            ...options
+        };
+        Reflect.defineMetadata(constants_js_1.RESOLVER_METADATA, metadata, target, propertyKey);
+    };
+}
+exports.ApiResolver = ApiResolver;

package/cjs/exception/http-errors/not-acceptable.error.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotAcceptableError = void 0;
+const i18n_1 = require("@opra/i18n");
+const index_js_1 = require("../../enums/index.js");
+const api_exception_js_1 = require("../api-exception.js");
+/**
+ * 406 Not Acceptable
+ * This response is sent when the web server, after performing server-driven content negotiation,
+ * doesn't find any content that conforms to the criteria given by the user agent.
+ */
+class NotAcceptableError extends api_exception_js_1.ApiException {
+    constructor(response, cause) {
+        super(response, cause);
+        this.status = index_js_1.HttpStatus.NOT_ACCEPTABLE;
+    }
+    _initResponse(response) {
+        super._initResponse({
+            message: (0, i18n_1.translate)('error:NOT_ACCEPTABLE', 'Not Acceptable'),
+            severity: 'error',
+            code: 'NOT_ACCEPTABLE',
+            ...response
+        });
+    }
+}
+exports.NotAcceptableError = NotAcceptableError;

package/cjs/exception/index.js

@@ -7,7 +7,9 @@ tslib_1.__exportStar(require("./http-errors/failed-dependency.error.js"), export
 tslib_1.__exportStar(require("./http-errors/forbidden.error.js"), exports);
 tslib_1.__exportStar(require("./http-errors/internal-server.error.js"), exports);
 tslib_1.__exportStar(require("./http-errors/method-not-allowed.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/not-acceptable.error.js"), exports);
 tslib_1.__exportStar(require("./http-errors/not-found.error.js"), exports);
 tslib_1.__exportStar(require("./http-errors/unauthorized.error.js"), exports);
 tslib_1.__exportStar(require("./http-errors/unprocessable-entity.error.js"), exports);
 tslib_1.__exportStar(require("./resource-errors/resource-conflict.error.js"), exports);
+tslib_1.__exportStar(require("./resource-errors/resource-not-found.error.js"), exports);

package/cjs/exception/resource-errors/resource-not-found.error.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceNotFoundError = void 0;
+const i18n_1 = require("@opra/i18n");
+const index_js_1 = require("../../enums/index.js");
+const api_exception_js_1 = require("../api-exception.js");
+class ResourceNotFoundError extends api_exception_js_1.ApiException {
+    constructor(resource, keyValue, cause) {
+        super({
+            message: (0, i18n_1.translate)(`error:RESOURCE_NOT_FOUND`, { resource: resource + '@' + keyValue }),
+            severity: 'error',
+            code: 'RESOURCE_NOT_FOUND',
+            subject: resource,
+            key: keyValue
+        }, cause);
+        this.status = index_js_1.HttpStatus.NOT_FOUND;
+    }
+}
+exports.ResourceNotFoundError = ResourceNotFoundError;

package/cjs/implementation/adapter/adapter.js

@@ -41,8 +41,12 @@ class OpraAdapter {
                     continue;
                 }
                 try {
-                    const resource = context.query.resource;
                     const promise = (async () => {
+                        if (context.query.queryType === 'metadata') {
+                            await this._metadataExecute(context);
+                            return;
+                        }
+                        const resource = context.query.resource;
                         await resource.prepare(context);
                         if (this.userContextResolver && !userContext)
                             userContext = this.userContextResolver({
@@ -91,6 +95,32 @@ class OpraAdapter {
             }
         }
     }
+    async _metadataExecute(ctx) {
+        const query = ctx.query;
+        let out;
+        if (query.resourcePath.length > 2)
+            throw new index_js_1.BadRequestError();
+        if (query.resourcePath?.length) {
+            if (query.resourcePath[0] === 'resources') {
+                const resource = this.service.getResource(query.resourcePath[1]);
+                out = resource.getMetadata();
+                query.resourcePath[1] = resource.name;
+            }
+            else if (query.resourcePath[0] === 'types') {
+                const dataType = this.service.getDataType(query.resourcePath[1]);
+                out = dataType.getMetadata();
+                query.resourcePath[1] = dataType.name;
+            }
+            else
+                throw new index_js_1.BadRequestError();
+            ctx.response.value = {
+                '@opra:metadata': '/$metadata/' + query.resourcePath.join('/'),
+                ...out
+            };
+            return;
+        }
+        ctx.response.value = this.service.getMetadata();
+    }
     static async initI18n(options) {
         if (options?.i18n instanceof i18n_1.I18n)
             return options.i18n;

package/cjs/implementation/adapter/http-adapter.js

@@ -33,7 +33,7 @@ class OpraHttpAdapter extends adapter_js_1.OpraAdapter {
         const query = this.buildQuery(url, method, body);
         if (!query)
             throw new index_js_2.MethodNotAllowedError({
-                message: `Method "${method}" is not allowed by target resource`
+                message: `Method "${method}" is not allowed by target endpoint`
             });
         return new query_context_js_1.QueryContext({
             service: this.service,
@@ -44,119 +44,146 @@ class OpraHttpAdapter extends adapter_js_1.OpraAdapter {
             continueOnError: query.operation === 'read'
         });
     }
+    buildMetadataQuery(url) {
+        const pathLen = url.path.size;
+        const resourcePath = [];
+        let pathIndex = 0;
+        while (pathIndex < pathLen) {
+            const p = url.path.get(pathIndex++);
+            if (p.key)
+                throw new index_js_2.BadRequestError();
+            if (p.resource !== '$metadata') {
+                if (pathIndex === 1)
+                    resourcePath.push('resources');
+                resourcePath.push(p.resource);
+            }
+        }
+        const opts = {
+            pick: url.searchParams.get('$pick'),
+            omit: url.searchParams.get('$omit'),
+            include: url.searchParams.get('$include'),
+        };
+        return query_interface_js_1.OpraQuery.forGetMetadata(resourcePath, opts);
+    }
     buildQuery(url, method, body) {
         let container = this.service;
         try {
-            let pathIndex = 0;
             const pathLen = url.path.size;
+            // Check if requesting metadata
+            for (let i = 0; i < pathLen; i++) {
+                const p = url.path.get(i);
+                if (p.resource === '$metadata') {
+                    if (method !== 'GET')
+                        return;
+                    return this.buildMetadataQuery(url);
+                }
+            }
+            let pathIndex = 0;
             while (pathIndex < pathLen) {
                 let p = url.path.get(pathIndex++);
                 const resource = container.getResource(p.resource);
                 // Move through path directories (containers)
                 if (resource instanceof container_resource_handler_js_1.ContainerResourceHandler) {
                     container = resource;
+                    continue;
                 }
-                else {
-                    method = method.toUpperCase();
-                    if (resource instanceof entity_resource_handler_js_1.EntityResourceHandler) {
-                        const scope = p.key ? 'instance' : 'collection';
-                        if (pathIndex < pathLen && !(method === 'GET' && scope === 'instance'))
-                            return;
-                        let query;
-                        switch (method) {
-                            case 'GET': {
-                                if (scope === 'collection') {
-                                    query = query_interface_js_1.OpraQuery.forSearch(resource, {
-                                        filter: url.searchParams.get('$filter'),
-                                        limit: url.searchParams.get('$limit'),
-                                        skip: url.searchParams.get('$skip'),
-                                        distinct: url.searchParams.get('$distinct'),
-                                        count: url.searchParams.get('$count'),
-                                        sort: url.searchParams.get('$sort'),
-                                        pick: url.searchParams.get('$pick'),
-                                        omit: url.searchParams.get('$omit'),
-                                        include: url.searchParams.get('$include'),
-                                    });
-                                }
-                                else {
-                                    query = query_interface_js_1.OpraQuery.forGet(resource, p.key, {
-                                        pick: url.searchParams.get('$pick'),
-                                        omit: url.searchParams.get('$omit'),
-                                        include: url.searchParams.get('$include')
-                                    });
-                                    // Move through properties
-                                    let nested;
-                                    let path = resource.name;
-                                    while (pathIndex < pathLen) {
-                                        const dataType = nested
-                                            ? this.service.getDataType(nested.property.type || 'string')
-                                            : query.resource.dataType;
-                                        if (!(dataType instanceof complex_type_js_1.ComplexType))
-                                            throw new Error(`"${path}" is not a ComplexType and has no properties.`);
-                                        p = url.path.get(pathIndex++);
-                                        path += '.' + p.resource;
-                                        const prop = dataType.properties?.[p.resource];
-                                        if (!prop)
-                                            throw new index_js_2.NotFoundError({ message: `Invalid or unknown resource path (${path})` });
-                                        const q = query_interface_js_1.OpraQuery.forGetProperty(prop);
-                                        if (nested) {
-                                            nested.nested = q;
-                                        }
-                                        else {
-                                            query.nested = q;
-                                        }
-                                        nested = q;
+                method = method.toUpperCase();
+                if (resource instanceof entity_resource_handler_js_1.EntityResourceHandler) {
+                    const scope = p.key ? 'instance' : 'collection';
+                    if (pathIndex < pathLen && !(method === 'GET' && scope === 'instance'))
+                        return;
+                    let query;
+                    switch (method) {
+                        case 'GET': {
+                            if (scope === 'collection') {
+                                query = query_interface_js_1.OpraQuery.forSearch(resource, {
+                                    filter: url.searchParams.get('$filter'),
+                                    limit: url.searchParams.get('$limit'),
+                                    skip: url.searchParams.get('$skip'),
+                                    distinct: url.searchParams.get('$distinct'),
+                                    count: url.searchParams.get('$count'),
+                                    sort: url.searchParams.get('$sort'),
+                                    pick: url.searchParams.get('$pick'),
+                                    omit: url.searchParams.get('$omit'),
+                                    include: url.searchParams.get('$include'),
+                                });
+                            }
+                            else {
+                                query = query_interface_js_1.OpraQuery.forGetEntity(resource, p.key, {
+                                    pick: url.searchParams.get('$pick'),
+                                    omit: url.searchParams.get('$omit'),
+                                    include: url.searchParams.get('$include')
+                                });
+                                // Move through properties
+                                let nested;
+                                let path = resource.name;
+                                while (pathIndex < pathLen) {
+                                    const dataType = nested
+                                        ? this.service.getDataType(nested.property.type || 'string')
+                                        : query.resource.dataType;
+                                    if (!(dataType instanceof complex_type_js_1.ComplexType))
+                                        throw new Error(`"${path}" is not a ComplexType and has no properties.`);
+                                    p = url.path.get(pathIndex++);
+                                    path += '.' + p.resource;
+                                    const prop = dataType.properties?.[p.resource];
+                                    if (!prop)
+                                        throw new index_js_2.NotFoundError({ message: `Invalid or unknown resource path (${path})` });
+                                    const q = query_interface_js_1.OpraQuery.forGetProperty(prop);
+                                    if (nested) {
+                                        nested.nested = q;
+                                    }
+                                    else {
+                                        query.nested = q;
                                     }
+                                    nested = q;
                                 }
-                                break;
                             }
-                            case 'DELETE': {
-                                if (scope === 'collection') {
-                                    query = query_interface_js_1.OpraQuery.forDeleteMany(resource, {
-                                        filter: url.searchParams.get('$filter'),
-                                    });
-                                }
-                                else {
-                                    query = query_interface_js_1.OpraQuery.forDelete(resource, p.key);
-                                }
-                                break;
+                            break;
+                        }
+                        case 'DELETE': {
+                            if (scope === 'collection') {
+                                query = query_interface_js_1.OpraQuery.forDeleteMany(resource, {
+                                    filter: url.searchParams.get('$filter'),
+                                });
                             }
-                            case 'POST': {
-                                if (scope === 'collection') {
-                                    query = query_interface_js_1.OpraQuery.forCreate(resource, body, {
-                                        pick: url.searchParams.get('$pick'),
-                                        omit: url.searchParams.get('$omit'),
-                                        include: url.searchParams.get('$include')
-                                    });
-                                }
-                                break;
+                            else {
+                                query = query_interface_js_1.OpraQuery.forDelete(resource, p.key);
                             }
-                            case 'PATCH': {
-                                if (scope === 'collection') {
-                                    query = query_interface_js_1.OpraQuery.forUpdateMany(resource, body, {
-                                        filter: url.searchParams.get('$filter')
-                                    });
-                                }
-                                else {
-                                    query = query_interface_js_1.OpraQuery.forUpdate(resource, p.key, body, {
-                                        pick: url.searchParams.get('$pick'),
-                                        omit: url.searchParams.get('$omit'),
-                                        include: url.searchParams.get('$include')
-                                    });
-                                }
-                                break;
+                            break;
+                        }
+                        case 'POST': {
+                            if (scope === 'collection') {
+                                query = query_interface_js_1.OpraQuery.forCreate(resource, body, {
+                                    pick: url.searchParams.get('$pick'),
+                                    omit: url.searchParams.get('$omit'),
+                                    include: url.searchParams.get('$include')
+                                });
+                            }
+                            break;
+                        }
+                        case 'PATCH': {
+                            if (scope === 'collection') {
+                                query = query_interface_js_1.OpraQuery.forUpdateMany(resource, body, {
+                                    filter: url.searchParams.get('$filter')
+                                });
+                            }
+                            else {
+                                query = query_interface_js_1.OpraQuery.forUpdate(resource, p.key, body, {
+                                    pick: url.searchParams.get('$pick'),
+                                    omit: url.searchParams.get('$omit'),
+                                    include: url.searchParams.get('$include')
+                                });
                             }
+                            break;
                         }
-                        return query;
                     }
+                    return query;
                 }
             }
             throw new index_js_2.InternalServerError();
         }
         catch (e) {
-            if (e instanceof index_js_2.ApiException)
-                throw e;
-            throw new index_js_2.BadRequestError({ message: e.message });
+            throw index_js_2.BadRequestError.wrap(e);
         }
     }
     async sendResponse(executionContext, queryContexts) {

package/cjs/implementation/data-type/complex-type.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComplexType = void 0;
+const tslib_1 = require("tslib");
+const putil_merge_1 = tslib_1.__importDefault(require("putil-merge"));
 const responsive_object_js_1 = require("../../utils/responsive-object.js");
 const terminal_utils_js_1 = require("../../utils/terminal-utils.js");
 const data_type_js_1 = require("./data-type.js");
@@ -28,6 +30,18 @@ class ComplexType extends data_type_js_1.DataType {
             throw new Error(`"${this.name}" type has no property named "${name}"`);
         return t;
     }
+    getMetadata() {
+        const out = super.getMetadata();
+        if (this.additionalProperties)
+            out.additionalProperties = this.additionalProperties;
+        if (this.ownProperties) {
+            out.properties = {};
+            for (const [k, prop] of Object.entries(this.ownProperties)) {
+                out.properties[k] = (0, putil_merge_1.default)({}, prop, { deep: true });
+            }
+        }
+        return out;
+    }
     toString() {
         return `[${Object.getPrototypeOf(this).constructor.name} ${this.name}]`;
     }

package/cjs/implementation/data-type/data-type.js

@@ -25,11 +25,23 @@ class DataType {
     get description() {
         return this._args.description;
     }
+    get abstract() {
+        return !!this._args.abstract;
+    }
     get ctor() {
         return this._args.ctor;
     }
     is(typeName) {
         return this.name === typeName || !!(this.base && this.base.is(typeName));
     }
+    getMetadata() {
+        return {
+            kind: this.kind,
+            base: this.base?.name,
+            abstract: this.abstract ? true : undefined,
+            name: this.name,
+            description: this.description,
+        };
+    }
 }
 exports.DataType = DataType;

package/cjs/implementation/data-type/entity-type.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityType = void 0;
-const optionals_1 = require("@opra/optionals");
+const tslib_1 = require("tslib");
+const Optionals = tslib_1.__importStar(require("@opra/optionals"));
 const complex_type_js_1 = require("./complex-type.js");
 class EntityType extends complex_type_js_1.ComplexType {
     constructor(owner, args, base) {
@@ -10,8 +11,8 @@ class EntityType extends complex_type_js_1.ComplexType {
         }, base);
         this._args.kind = 'EntityType';
         // Try to determine primary key info from SQB
-        if (args.ctor) {
-            const sqbEntity = optionals_1.SqbConnect.EntityMetadata.get(args.ctor);
+        if (Optionals.SqbConnect && args.ctor) {
+            const sqbEntity = Optionals.SqbConnect.EntityMetadata.get(args.ctor);
             if (sqbEntity?.indexes) {
                 const primaryIndex = sqbEntity.indexes.find(x => x.primary);
                 if (primaryIndex) {

package/cjs/implementation/opra-document.js

@@ -74,7 +74,8 @@ class OpraDocument {
             recursiveSet.add(schema.name);
             let baseType;
             if (schema.base) {
-                if (!this.types[schema.base]) {
+                baseType = this.types[schema.base];
+                if (!baseType) {
                     const baseSchema = dataTypes.find(dt => dt.name.toLowerCase() === schema.base?.toLowerCase()) ||
                         internal_data_types_js_1.internalDataTypes.get(schema.base.toLowerCase());
                     if (!baseSchema)
@@ -106,11 +107,6 @@ class OpraDocument {
             return dataType;
         };
         dataTypes.forEach(dataType => processDataType(dataType));
-        // Sort data types by name
-        const newTypes = (0, responsive_object_js_1.Responsive)();
-        Object.keys(this.types).sort()
-            .forEach(name => newTypes[name] = this.types[name]);
-        this._types = newTypes;
     }
 }
 exports.OpraDocument = OpraDocument;

package/cjs/implementation/opra-service.js

@@ -1,7 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpraService = void 0;
+const tslib_1 = require("tslib");
+const putil_merge_1 = tslib_1.__importDefault(require("putil-merge"));
 const schema_1 = require("@opra/schema");
+const constants_js_1 = require("../constants.js");
+const internal_data_types_js_1 = require("../utils/internal-data-types.js");
 const responsive_object_js_1 = require("../utils/responsive-object.js");
 const entity_type_js_1 = require("./data-type/entity-type.js");
 const opra_document_js_1 = require("./opra-document.js");
@@ -32,6 +36,24 @@ class OpraService extends opra_document_js_1.OpraDocument {
             throw new Error(`"${name}" is not an EntityResource`);
         return t;
     }
+    getMetadata() {
+        const out = {
+            '@opra:metadata': '/$metadata',
+            version: constants_js_1.OpraVersion,
+            servers: this.servers?.map(x => (0, putil_merge_1.default)({}, x, { deep: true })),
+            info: (0, putil_merge_1.default)({}, this.info, { deep: true }),
+            types: [],
+            resources: []
+        };
+        for (const [k, dataType] of Object.entries(this.types)) {
+            if (!internal_data_types_js_1.internalDataTypes.has(k))
+                out.types.push(dataType.getMetadata());
+        }
+        for (const resource of Object.values(this.resources)) {
+            out.resources.push(resource.getMetadata());
+        }
+        return out;
+    }
     _addResources(resources) {
         for (const r of resources) {
             if (schema_1.OpraSchema.isEntityResource(r)) {

package/cjs/implementation/resource/entity-resource-handler.js

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EntityResourceHandler = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const i18n_1 = require("@opra/i18n");
+const index_js_1 = require("../../exception/index.js");
 const query_interface_js_1 = require("../../interfaces/query.interface.js");
+const complex_type_js_1 = require("../data-type/complex-type.js");
 const entity_type_js_1 = require("../data-type/entity-type.js");
 const resource_handler_js_1 = require("./resource-handler.js");
-var isSearchQuery = query_interface_js_1.OpraQuery.isSearchQuery;
-const index_js_1 = require("../../exception/index.js");
 class EntityResourceHandler extends resource_handler_js_1.ResourceHandler {
     service;
     dataType;
@@ -24,7 +25,7 @@ class EntityResourceHandler extends resource_handler_js_1.ResourceHandler {
     }
     async execute(ctx) {
         const { query } = ctx;
-        if (isSearchQuery(query)) {
+        if (query_interface_js_1.OpraQuery.isSearchQuery(query)) {
             const promises = [];
             let search;
             let count;
@@ -43,12 +44,28 @@ class EntityResourceHandler extends resource_handler_js_1.ResourceHandler {
         }
         ctx.response.value = await this._executeFn(ctx, query.queryType);
     }
-    async _executeFn(ctx, fnName) {
-        const fn = this._args[fnName];
-        let result = typeof fn === 'function' ? (await fn(ctx)) : undefined;
-        switch (fnName) {
+    async _executeFn(ctx, queryType) {
+        const resolverInfo = this._args.resolvers?.[queryType];
+        if (resolverInfo.forbidden || !resolverInfo.handler)
+            throw new index_js_1.ForbiddenError({
+                message: (0, i18n_1.translate)('RESOLVER_FORBIDDEN', { queryType }),
+                severity: 'error',
+                code: 'RESOLVER_FORBIDDEN'
+            });
+        let result = await resolverInfo.handler(ctx);
+        switch (queryType) {
             case 'search':
-                return { items: Array.isArray(result) ? result : (ctx.response.value ? [result] : []) };
+                return {
+                    '@opra:metadata': '/$metadata/types/' + this.dataType.name,
+                    items: Array.isArray(result) ? result : (ctx.response.value ? [result] : [])
+                };
+            case 'get':
+            case 'update':
+                if (!result) {
+                    const query = ctx.query;
+                    throw new index_js_1.ResourceNotFoundError(this.name, query.keyValue);
+                }
+                break;
             case 'count':
                 return { count: result || 0 };
             case 'delete':
@@ -63,18 +80,24 @@ class EntityResourceHandler extends resource_handler_js_1.ResourceHandler {
                     affectedRecords = result.affectedRows || result.affectedRecords;
                 return { affectedRecords };
         }
-        result = Array.isArray(result) ? result[0] : result;
         if (!result)
-            throw new index_js_1.UnprocessableEntityError();
+            return;
+        result = Array.isArray(result) ? result[0] : result;
+        let dataType = this.dataType;
         if (ctx.resultPath) {
             const pathArray = ctx.resultPath.split('.');
             for (const property of pathArray) {
+                const prop = dataType instanceof complex_type_js_1.ComplexType ? dataType.properties?.[property] : undefined;
+                dataType = prop && prop.type ? this.service.types[prop.type || 'string'] : undefined;
                 result = result && typeof result === 'object' && result[property];
             }
         }
-        if (fnName === 'create')
+        if (queryType === 'create')
             ctx.response.status = 201;
-        return result;
+        return {
+            '@opra:metadata': dataType ? '/$metadata/types/' + dataType.name : '__unknown__',
+            ...result
+        };
     }
 }
 exports.EntityResourceHandler = EntityResourceHandler;

package/cjs/implementation/resource/resource-handler.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResourceHandler = void 0;
+const tslib_1 = require("tslib");
+const putil_merge_1 = tslib_1.__importDefault(require("putil-merge"));
 const terminal_utils_js_1 = require("../../utils/terminal-utils.js");
 class ResourceHandler {
     _args;
+    path;
     constructor(args) {
         this._args = args;
     }
@@ -23,6 +26,17 @@ class ResourceHandler {
             await fn(ctx);
         }
     }
+    getMetadata() {
+        return (0, putil_merge_1.default)({}, {
+            ...this._args,
+            instance: undefined,
+        }, {
+            deep: true,
+            filter: (source, key) => {
+                return (key !== 'instance' && typeof source[key] !== 'function' && source[key] != null);
+            }
+        });
+    }
     [terminal_utils_js_1.nodeInspectCustom]() {
         return `[${terminal_utils_js_1.colorFgYellow + Object.getPrototypeOf(this).constructor.name + terminal_utils_js_1.colorReset}` +
             ` ${terminal_utils_js_1.colorFgMagenta + this.name + terminal_utils_js_1.colorReset}]`;