@balena/pinejs 21.0.5-build-renovate-body-parser-2-x-9d6dece509c90b60fdbc72a2d1432b14096fb624-1 → 21.1.0-build-odata-metadata-json-395a55cb54e7b9ce0960ab93aad5f69d6c0e0462-2

package/.versionbot/CHANGELOG.yml

@@ -1,16 +1,21 @@
 - commits:
-    - subject: Update dependency body-parser to v2
-      hash: 9d6dece509c90b60fdbc72a2d1432b14096fb624
+    - subject: Return $metadata resource as odata + openapi spec
+      hash: f5a29ea44c6d1c6b933a727474329fad195ff6c9
       body: |
-        Update body-parser from 1.20.3 to 2.2.0
+        Returning odata and openapi specs in json format.
+        Specs are scoped to the request permissions.
+        Different users (roles) will receive different metadata endpoints
+        and resources.
       footer:
-        Change-type: patch
-        change-type: patch
-      author: balena-renovate[bot]
+        Change-type: minor
+        change-type: minor
+        Signed-off-by: Harald Fischer <harald@balena.io>
+        signed-off-by: Harald Fischer <harald@balena.io>
+      author: Harald Fischer
       nested: []
-  version: 21.0.5
+  version: 21.1.0
   title: ""
-  date: 2025-03-31T03:58:53.328Z
+  date: 2025-04-01T11:35:56.344Z
 - commits:
     - subject: Update minio/mc Docker tag to RELEASE.2024-11-21T17-21-54Z
       hash: dcb916fe5dbfd46de8284678eed69ce91a04ea42

package/CHANGELOG.md

@@ -4,10 +4,10 @@ All notable changes to this project will be documented in this file
 automatically by Versionist. DO NOT EDIT THIS FILE MANUALLY!
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-# v21.0.5
-## (2025-03-31)
+# v21.1.0
+## (2025-04-01)
 
-* Update dependency body-parser to v2 [balena-renovate[bot]]
+* Return $metadata resource as odata + openapi spec [Harald Fischer]
 
 # v21.0.4
 ## (2025-03-31)

package/VERSION

@@ -1 +1 @@
-21.0.5
+21.1.0

package/out/odata-metadata/odata-metadata-generator.d.ts

@@ -1,5 +1,65 @@
 import type { AbstractSqlModel } from '@balena/abstract-sql-compiler';
+import type { PermissionLookup } from '../sbvr-api/permissions.js';
+type ODataCsdlV4References = {
+    [URI: string]: {
+        $Include: Array<{
+            $Namespace: string;
+            $Alias: string;
+            [annotation: string]: string | boolean;
+        }>;
+    };
+};
+type ODataCsdlV4BaseProperty = {
+    [annotation: string]: string | boolean | undefined;
+    $Type?: string;
+    $Nullable?: boolean;
+};
+type ODataCsdlV4StructuralProperty = ODataCsdlV4BaseProperty & {
+    $Kind?: 'Property';
+};
+type ODataCsdlV4NavigationProperty = ODataCsdlV4BaseProperty & {
+    $Kind: 'NavigationProperty';
+    $Partner?: string;
+};
+type ODataCsdlV4Property = ODataCsdlV4BaseProperty | ODataCsdlV4StructuralProperty | ODataCsdlV4NavigationProperty;
+type ODataCsdlV4EntityType = {
+    $Kind: 'EntityType';
+    $Key: string[];
+    [property: string]: true | string[] | string | ODataCsdlV4Property;
+};
+type ODataCsdlV4EntityContainerEntries = {
+    $Type: string;
+    [property: string]: true | string | ODataCapabilitiesUDIRRestrictionsMethod;
+};
+type ODataCsdlV4EntityContainer = {
+    $Kind: 'EntityContainer';
+    '@Capabilities.BatchSupported'?: boolean;
+    [resourceOrAnnotation: string]: boolean | string | ODataCsdlV4EntityContainerEntries | undefined;
+};
+type ODataCsdlV4Schema = {
+    $Alias: string;
+    '@Core.DefaultNamespace': true;
+    [resource: string]: string | boolean | ODataCsdlV4EntityContainer | ODataCsdlV4EntityType;
+};
+type OdataCsdlV4 = {
+    $Version: string;
+    $Reference: ODataCsdlV4References;
+    $EntityContainer: string;
+    [schema: string]: string | ODataCsdlV4References | ODataCsdlV4Schema;
+};
+type ODataCapabilitiesUDIRRestrictionsMethod = {
+    Updatable: boolean;
+} | {
+    Deletable: boolean;
+} | {
+    Insertable: boolean;
+} | {
+    Readable: boolean;
+} | {
+    Filterable: boolean;
+};
 export declare const generateODataMetadata: {
-    (vocabulary: string, abstractSqlModel: AbstractSqlModel): string;
+    (vocabulary: string, abstractSqlModel: AbstractSqlModel, permissionsLookup?: PermissionLookup): OdataCsdlV4;
     version: any;
 };
+export {};

package/out/odata-metadata/odata-metadata-generator.js

@@ -1,5 +1,84 @@
 import { sbvrTypes } from '../sbvr-api/sbvr-utils.js';
 import { version } from '../config-loader/env.js';
+const odataVocabularyReferences = {
+    'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.json': {
+        $Include: [
+            {
+                $Namespace: 'Org.OData.Core.V1',
+                $Alias: 'Core',
+                '@Core.DefaultNamespace': true,
+            },
+        ],
+    },
+    'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Measures.V1.json': {
+        $Include: [
+            {
+                $Namespace: 'Org.OData.Measures.V1',
+                $Alias: 'Measures',
+            },
+        ],
+    },
+    'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.json': {
+        $Include: [
+            {
+                $Namespace: 'Org.OData.Aggregation.V1',
+                $Alias: 'Aggregation',
+            },
+        ],
+    },
+    'https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.json': {
+        $Include: [
+            {
+                $Namespace: 'Org.OData.Capabilities.V1',
+                $Alias: 'Capabilities',
+            },
+        ],
+    },
+};
+const restrictionsLookup = (method, value) => {
+    const lookup = {
+        update: {
+            '@Capabilities.UpdateRestrictions': {
+                Updatable: value,
+            },
+            '@Capabilities.FilterRestrictions': {
+                Filterable: true,
+            },
+        },
+        delete: {
+            '@Capabilities.DeleteRestrictions': {
+                Deletable: value,
+            },
+            '@Capabilities.FilterRestrictions': {
+                Filterable: true,
+            },
+        },
+        create: {
+            '@Capabilities.InsertRestrictions': {
+                Insertable: value,
+            },
+        },
+        read: {
+            '@Capabilities.ReadRestrictions': {
+                Readable: value,
+            },
+            '@Capabilities.FilterRestrictions': {
+                Filterable: true,
+            },
+        },
+    };
+    if (method === 'all') {
+        return {
+            ...lookup['update'],
+            ...lookup['delete'],
+            ...lookup['create'],
+            ...lookup['read'],
+        };
+    }
+    else {
+        return lookup[method] ?? {};
+    }
+};
 const getResourceName = (resourceName) => resourceName
     .split('-')
     .map((namePart) => namePart.split(' ').join('_'))
@@ -7,17 +86,47 @@ const getResourceName = (resourceName) => resourceName
 const forEachUniqueTable = (model, callback) => {
     const usedTableNames = {};
     const result = [];
-    for (const [key, table] of Object.entries(model)) {
+    for (const key of Object.keys(model.abstractSqlModel.tables).sort()) {
+        const table = model.abstractSqlModel.tables[key];
         if (typeof table !== 'string' &&
             !table.primitive &&
-            !usedTableNames[table.name]) {
+            !usedTableNames[table.name] &&
+            model.preparedPermissionLookup) {
             usedTableNames[table.name] = true;
             result.push(callback(key, table));
         }
     }
     return result;
 };
-export const generateODataMetadata = (vocabulary, abstractSqlModel) => {
+const preparePermissionsLookup = (permissionLookup) => {
+    const resourcesAndOps = {};
+    for (const resourceOpsAuths of Object.keys(permissionLookup)) {
+        const [vocabulary, resource, rule] = resourceOpsAuths.split('.');
+        resourcesAndOps[vocabulary] ??= {};
+        resourcesAndOps[vocabulary][resource] ??= {
+            ['read']: false,
+            ['create']: false,
+            ['update']: false,
+            ['delete']: false,
+        };
+        if (rule === 'all' || (resource === 'all' && rule === undefined)) {
+            resourcesAndOps[vocabulary][resource] = {
+                ['read']: true,
+                ['create']: true,
+                ['update']: true,
+                ['delete']: true,
+            };
+        }
+        else if (rule === 'read' ||
+            rule === 'create' ||
+            rule === 'update' ||
+            rule === 'delete') {
+            resourcesAndOps[vocabulary][resource][rule] = true;
+        }
+    }
+    return resourcesAndOps;
+};
+export const generateODataMetadata = (vocabulary, abstractSqlModel, permissionsLookup) => {
     const complexTypes = {};
     const resolveDataType = (fieldType) => {
         if (sbvrTypes[fieldType] == null) {
@@ -30,103 +139,83 @@ export const generateODataMetadata = (vocabulary, abstractSqlModel) => {
         }
         return sbvrTypes[fieldType].types.odata.name;
     };
-    const model = abstractSqlModel.tables;
-    const associations = [];
-    forEachUniqueTable(model, (_key, { name: resourceName, fields }) => {
+    const prepPermissionsLookup = permissionsLookup
+        ? preparePermissionsLookup(permissionsLookup)
+        : {};
+    const model = {
+        vocabulary,
+        abstractSqlModel,
+        preparedPermissionLookup: prepPermissionsLookup,
+    };
+    const metaBalenaEntries = {};
+    const entityContainer = {
+        $Kind: 'EntityContainer',
+        '@Capabilities.KeyAsSegmentSupported': false,
+    };
+    forEachUniqueTable(model, (_key, { idField, name: resourceName, fields }) => {
         resourceName = getResourceName(resourceName);
-        for (const { dataType, required, references } of fields) {
-            if (dataType === 'ForeignKey' && references != null) {
-                const { resourceName: referencedResource } = references;
-                associations.push({
-                    name: resourceName + referencedResource,
-                    ends: [
-                        { resourceName, cardinality: required ? '1' : '0..1' },
-                        { resourceName: referencedResource, cardinality: '*' },
-                    ],
-                });
-            }
+        const permissions = model?.preparedPermissionLookup?.['resource']?.['all'] ??
+            model?.preparedPermissionLookup?.[model.vocabulary]?.['all'] ??
+            model?.preparedPermissionLookup?.[model.vocabulary]?.[resourceName];
+        if (!permissions) {
+            return;
+        }
+        const uniqueTable = {
+            $Kind: 'EntityType',
+            $Key: [idField],
+        };
+        fields
+            .filter(({ dataType }) => dataType !== 'ForeignKey')
+            .map(({ dataType, fieldName, required }) => {
+            dataType = resolveDataType(dataType);
+            fieldName = getResourceName(fieldName);
+            uniqueTable[fieldName] = {
+                $Type: dataType,
+                $Nullable: !required,
+                '@Core.Computed': fieldName === 'created_at' || fieldName === 'modified_at'
+                    ? true
+                    : false,
+            };
+        });
+        fields
+            .filter(({ dataType, references }) => dataType === 'ForeignKey' && references != null)
+            .map(({ fieldName, references, required }) => {
+            const { resourceName: referencedResource } = references;
+            const referencedResourceName = model.abstractSqlModel.tables[referencedResource]?.name;
+            const typeReference = referencedResourceName || referencedResource;
+            fieldName = getResourceName(fieldName);
+            uniqueTable[fieldName] = {
+                $Kind: 'NavigationProperty',
+                $Partner: resourceName,
+                $Nullable: !required,
+                $Type: vocabulary + '.' + getResourceName(typeReference),
+            };
+        });
+        metaBalenaEntries[resourceName] = uniqueTable;
+        let entityCon = {
+            $Collection: true,
+            $Type: vocabulary + '.' + resourceName,
+        };
+        for (const [resKey, resValue] of Object.entries(permissions)) {
+            entityCon = { ...entityCon, ...restrictionsLookup(resKey, resValue) };
         }
+        entityContainer[resourceName] = entityCon;
     });
-    return (`
-		<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
-		<edmx:Edmx Version="1.0" xmlns:edmx="http://schemas.microsoft.com/ado/2007/06/edmx">
-			<edmx:DataServices xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:DataServiceVersion="2.0">
-				<Schema Namespace="${vocabulary}"
-					xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
-					xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
-					xmlns="http://schemas.microsoft.com/ado/2008/09/edm">
-
-				` +
-        forEachUniqueTable(model, (_key, { idField, name: resourceName, fields }) => {
-            resourceName = getResourceName(resourceName);
-            return (`
-					<EntityType Name="${resourceName}">
-						<Key>
-							<PropertyRef Name="${idField}" />
-						</Key>
-
-						` +
-                fields
-                    .filter(({ dataType }) => dataType !== 'ForeignKey')
-                    .map(({ dataType, fieldName, required }) => {
-                    dataType = resolveDataType(dataType);
-                    fieldName = getResourceName(fieldName);
-                    return `<Property Name="${fieldName}" Type="${dataType}" Nullable="${!required}" />`;
-                })
-                    .join('\n') +
-                '\n' +
-                fields
-                    .filter(({ dataType, references }) => dataType === 'ForeignKey' && references != null)
-                    .map(({ fieldName, references }) => {
-                    const { resourceName: referencedResource } = references;
-                    fieldName = getResourceName(fieldName);
-                    return `<NavigationProperty Name="${fieldName}" Relationship="${vocabulary}.${resourceName + referencedResource}" FromRole="${resourceName}" ToRole="${referencedResource}" />`;
-                })
-                    .join('\n') +
-                '\n' +
-                `
-					</EntityType>`);
-        }).join('\n\n') +
-        associations
-            .map(({ name, ends }) => {
-            name = getResourceName(name);
-            return (`<Association Name="${name}">` +
-                '\n\t' +
-                ends
-                    .map(({ resourceName, cardinality }) => `<End Role="${resourceName}" Type="${vocabulary}.${resourceName}" Multiplicity="${cardinality}" />`)
-                    .join('\n\t') +
-                '\n' +
-                `</Association>`);
-        })
-            .join('\n') +
-        `
-					<EntityContainer Name="${vocabulary}Service" m:IsDefaultEntityContainer="true">
-
-					` +
-        forEachUniqueTable(model, (_key, { name: resourceName }) => {
-            resourceName = getResourceName(resourceName);
-            return `<EntitySet Name="${resourceName}" EntityType="${vocabulary}.${resourceName}" />`;
-        }).join('\n') +
-        '\n' +
-        associations
-            .map(({ name, ends }) => {
-            name = getResourceName(name);
-            return (`<AssociationSet Name="${name}" Association="${vocabulary}.${name}">` +
-                '\n\t' +
-                ends
-                    .map(({ resourceName }) => `<End Role="${resourceName}" EntitySet="${vocabulary}.${resourceName}" />`)
-                    .join('\n\t') +
-                `
-								</AssociationSet>`);
-        })
-            .join('\n') +
-        `
-					</EntityContainer>` +
-        Object.values(complexTypes).join('\n') +
-        `
-				</Schema>
-			</edmx:DataServices>
-		</edmx:Edmx>`);
+    const odataCsdl = {
+        $Version: '3.0',
+        $EntityContainer: vocabulary + '.ODataApi',
+        $Reference: odataVocabularyReferences,
+        [vocabulary]: {
+            $Alias: vocabulary,
+            '@Core.DefaultNamespace': true,
+            '@Core.Description': `OpenAPI specification for PineJS served SBVR datamodel: ${vocabulary}`,
+            '@Core.LongDescription': 'Auto-Genrated OpenAPI specification by utilizing OData CSDL to OpenAPI spec transformer.',
+            '@Core.SchemaVersion': version,
+            ...metaBalenaEntries,
+            ['ODataApi']: entityContainer,
+        },
+    };
+    return odataCsdl;
 };
 generateODataMetadata.version = version;
 //# sourceMappingURL=odata-metadata-generator.js.map

package/out/odata-metadata/odata-metadata-generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"odata-metadata-generator.js","sourceRoot":"","sources":["../../src/odata-metadata/odata-metadata-generator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAElD,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAU,EAAE,CACxD,YAAY;KACV,KAAK,CAAC,GAAG,CAAC;KACV,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAChD,IAAI,CAAC,IAAI,CAAC,CAAC;AAEd,MAAM,kBAAkB,GAAG,CAC1B,KAAiC,EACjC,QAA2D,EACrD,EAAE;IACR,MAAM,cAAc,GAAkC,EAAE,CAAC;IAEzD,MAAM,MAAM,GAAG,EAAE,CAAC;IAClB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAClD,IACC,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK,CAAC,SAAS;YAChB,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,EAC1B,CAAC;YACF,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACpC,UAAkB,EAClB,gBAAkC,EACjC,EAAE;IACH,MAAM,YAAY,GAAoC,EAAE,CAAC;IACzD,MAAM,eAAe,GAAG,CAAC,SAAiC,EAAU,EAAE;QACrE,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAI,SAAS,CAAC,SAAS,CAAc,CAAC,KAAK,CAAC,KAAK,CAAC;QACvE,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,YAAY,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;QACvC,CAAC;QACD,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,KAAK,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACtC,MAAM,YAAY,GAMb,EAAE,CAAC;IACR,kBAAkB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE;QAClE,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAC7C,KAAK,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,MAAM,EAAE,CAAC;YACzD,IAAI,QAAQ,KAAK,YAAY,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;gBACrD,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,UAAU,CAAC;gBACxD,YAAY,CAAC,IAAI,CAAC;oBACjB,IAAI,EAAE,YAAY,GAAG,kBAAkB;oBACvC,IAAI,EAAE;wBACL,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE;wBACtD,EAAE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,GAAG,EAAE;qBACtD;iBACD,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;IAEH,OAAO,CACN;;;;yBAIuB,UAAU;;;;;KAK9B;QACH,kBAAkB,CACjB,KAAK,EACL,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE;YACjD,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;YAC7C,OAAO,CACN;yBACoB,YAAY;;4BAET,OAAO;;;OAG5B;gBACF,MAAM;qBACJ,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,KAAK,YAAY,CAAC;qBACnD,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE;oBAC1C,QAAQ,GAAG,eAAe,CAAC,QAAkC,CAAC,CAAC;oBAC/D,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;oBACvC,OAAO,mBAAmB,SAAS,WAAW,QAAQ,eAAe,CAAC,QAAQ,MAAM,CAAC;gBACtF,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ,MAAM;qBACJ,MAAM,CACN,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5B,QAAQ,KAAK,YAAY,IAAI,UAAU,IAAI,IAAI,CAChD;qBACA,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;oBAClC,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,UAAW,CAAC;oBACzD,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;oBACvC,OAAO,6BAA6B,SAAS,mBAAmB,UAAU,IACzE,YAAY,GAAG,kBAChB,eAAe,YAAY,aAAa,kBAAkB,MAAM,CAAC;gBAClE,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC;gBACZ,IAAI;gBACJ;mBACc,CACd,CAAC;QACH,CAAC,CACD,CAAC,IAAI,CAAC,MAAM,CAAC;QACd,YAAY;aACV,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;YACvB,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,OAAO,CACN,sBAAsB,IAAI,IAAI;gBAC9B,MAAM;gBACN,IAAI;qBACF,GAAG,CACH,CAAC,EAAE,YAAY,EAAE,WAAW,EAAE,EAAE,EAAE,CACjC,cAAc,YAAY,WAAW,UAAU,IAAI,YAAY,mBAAmB,WAAW,MAAM,CACpG;qBACA,IAAI,CAAC,MAAM,CAAC;gBACd,IAAI;gBACJ,gBAAgB,CAChB,CAAC;QACH,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC;QACZ;8BAC4B,UAAU;;MAElC;QACJ,kBAAkB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,EAAE;YAC1D,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;YAC7C,OAAO,oBAAoB,YAAY,iBAAiB,UAAU,IAAI,YAAY,MAAM,CAAC;QAC1F,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACb,IAAI;QACJ,YAAY;aACV,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;YACvB,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;YAC7B,OAAO,CACN,yBAAyB,IAAI,kBAAkB,UAAU,IAAI,IAAI,IAAI;gBACrE,MAAM;gBACN,IAAI;qBACF,GAAG,CACH,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,CACpB,cAAc,YAAY,gBAAgB,UAAU,IAAI,YAAY,MAAM,CAC3E;qBACA,IAAI,CAAC,MAAM,CAAC;gBACd;0BACqB,CACrB,CAAC;QACH,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC;QACZ;wBACsB;QACtB,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACtC;;;eAGa,CACb,CAAC;AACH,CAAC,CAAC;AAEF,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC"}
+{"version":3,"file":"odata-metadata-generator.js","sourceRoot":"","sources":["../../src/odata-metadata/odata-metadata-generator.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAKlD,MAAM,yBAAyB,GAA0B;IACxD,oFAAoF,EACnF;QACC,QAAQ,EAAE;YACT;gBACC,UAAU,EAAE,mBAAmB;gBAC/B,MAAM,EAAE,MAAM;gBACd,wBAAwB,EAAE,IAAI;aAC9B;SACD;KACD;IACF,wFAAwF,EACvF;QACC,QAAQ,EAAE;YACT;gBACC,UAAU,EAAE,uBAAuB;gBACnC,MAAM,EAAE,UAAU;aAClB;SACD;KACD;IACF,2FAA2F,EAC1F;QACC,QAAQ,EAAE;YACT;gBACC,UAAU,EAAE,0BAA0B;gBACtC,MAAM,EAAE,aAAa;aACrB;SACD;KACD;IACF,4FAA4F,EAC3F;QACC,QAAQ,EAAE;YACT;gBACC,UAAU,EAAE,2BAA2B;gBACvC,MAAM,EAAE,cAAc;aACtB;SACD;KACD;CACF,CAAC;AAwGF,MAAM,kBAAkB,GAAG,CAC1B,MAA+D,EAC/D,KAAc,EACb,EAAE;IACH,MAAM,MAAM,GAAG;QACd,MAAM,EAAE;YACP,kCAAkC,EAAE;gBACnC,SAAS,EAAE,KAAK;aAChB;YACD,kCAAkC,EAAE;gBACnC,UAAU,EAAE,IAAI;aAChB;SACD;QACD,MAAM,EAAE;YACP,kCAAkC,EAAE;gBACnC,SAAS,EAAE,KAAK;aAChB;YACD,kCAAkC,EAAE;gBACnC,UAAU,EAAE,IAAI;aAChB;SACD;QACD,MAAM,EAAE;YACP,kCAAkC,EAAE;gBACnC,UAAU,EAAE,KAAK;aACjB;SACD;QACD,IAAI,EAAE;YACL,gCAAgC,EAAE;gBACjC,QAAQ,EAAE,KAAK;aACf;YACD,kCAAkC,EAAE;gBACnC,UAAU,EAAE,IAAI;aAChB;SACD;KACD,CAAC;IAEF,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACtB,OAAO;YACN,GAAG,MAAM,CAAC,QAAQ,CAAC;YACnB,GAAG,MAAM,CAAC,QAAQ,CAAC;YACnB,GAAG,MAAM,CAAC,QAAQ,CAAC;YACnB,GAAG,MAAM,CAAC,MAAM,CAAC;SACjB,CAAC;IACH,CAAC;SAAM,CAAC;QACP,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC7B,CAAC;AACF,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,YAAoB,EAAU,EAAE,CACxD,YAAY;KACV,KAAK,CAAC,GAAG,CAAC;KACV,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAChD,IAAI,CAAC,IAAI,CAAC,CAAC;AAEd,MAAM,kBAAkB,GAAG,CAC1B,KAA4B,EAC5B,QAGM,EACA,EAAE;IACR,MAAM,cAAc,GAAkC,EAAE,CAAC;IAEzD,MAAM,MAAM,GAAG,EAAE,CAAC;IAElB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACrE,MAAM,KAAK,GAAG,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAE9C,CAAC;QACF,IACC,OAAO,KAAK,KAAK,QAAQ;YACzB,CAAC,KAAK,CAAC,SAAS;YAChB,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC;YAC3B,KAAK,CAAC,wBAAwB,EAC7B,CAAC;YACF,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YAClC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC,CAAC;AAOF,MAAM,wBAAwB,GAAG,CAChC,gBAAkC,EACN,EAAE;IAC9B,MAAM,eAAe,GAA8B,EAAE,CAAC;IAEtD,KAAK,MAAM,gBAAgB,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC9D,MAAM,CAAC,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACjE,eAAe,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;QACnC,eAAe,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK;YACzC,CAAC,MAAM,CAAC,EAAE,KAAK;YACf,CAAC,QAAQ,CAAC,EAAE,KAAK;YACjB,CAAC,QAAQ,CAAC,EAAE,KAAK;YACjB,CAAC,QAAQ,CAAC,EAAE,KAAK;SACjB,CAAC;QAEF,IAAI,IAAI,KAAK,KAAK,IAAI,CAAC,QAAQ,KAAK,KAAK,IAAI,IAAI,KAAK,SAAS,CAAC,EAAE,CAAC;YAClE,eAAe,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,GAAG;gBACvC,CAAC,MAAM,CAAC,EAAE,IAAI;gBACd,CAAC,QAAQ,CAAC,EAAE,IAAI;gBAChB,CAAC,QAAQ,CAAC,EAAE,IAAI;gBAChB,CAAC,QAAQ,CAAC,EAAE,IAAI;aAChB,CAAC;QACH,CAAC;aAAM,IACN,IAAI,KAAK,MAAM;YACf,IAAI,KAAK,QAAQ;YACjB,IAAI,KAAK,QAAQ;YACjB,IAAI,KAAK,QAAQ,EAChB,CAAC;YACF,eAAe,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACpD,CAAC;IACF,CAAC;IACD,OAAO,eAAe,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACpC,UAAkB,EAClB,gBAAkC,EAClC,iBAAoC,EACnC,EAAE;IACH,MAAM,YAAY,GAAoC,EAAE,CAAC;IACzD,MAAM,eAAe,GAAG,CAAC,SAAiC,EAAU,EAAE;QACrE,IAAI,SAAS,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,SAAS,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,EAAE,WAAW,EAAE,GAAI,SAAS,CAAC,SAAS,CAAc,CAAC,KAAK,CAAC,KAAK,CAAC;QACvE,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;YACzB,YAAY,CAAC,SAAS,CAAC,GAAG,WAAW,CAAC;QACvC,CAAC;QACD,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IAC9C,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG,iBAAiB;QAC9C,CAAC,CAAC,wBAAwB,CAAC,iBAAiB,CAAC;QAC7C,CAAC,CAAC,EAAE,CAAC;IAEN,MAAM,KAAK,GAA0B;QACpC,UAAU;QACV,gBAAgB;QAChB,wBAAwB,EAAE,qBAAqB;KAC/C,CAAC;IAEF,MAAM,iBAAiB,GAAwB,EAAE,CAAC;IAClD,MAAM,eAAe,GAA+B;QACnD,KAAK,EAAE,iBAAiB;QACxB,qCAAqC,EAAE,KAAK;KAC5C,CAAC;IAEF,kBAAkB,CAAC,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE;QAC3E,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAE7C,MAAM,WAAW,GAChB,KAAK,EAAE,wBAAwB,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC;YACtD,KAAK,EAAE,wBAAwB,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC;YAC5D,KAAK,EAAE,wBAAwB,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC;QAErE,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,OAAO;QACR,CAAC;QAED,MAAM,WAAW,GAA0B;YAC1C,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,CAAC,OAAO,CAAC;SACf,CAAC;QAEF,MAAM;aACJ,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,KAAK,YAAY,CAAC;aACnD,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC1C,QAAQ,GAAG,eAAe,CAAC,QAAkC,CAAC,CAAC;YAC/D,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEvC,WAAW,CAAC,SAAS,CAAC,GAAG;gBACxB,KAAK,EAAE,QAAQ;gBACf,SAAS,EAAE,CAAC,QAAQ;gBACpB,gBAAgB,EACf,SAAS,KAAK,YAAY,IAAI,SAAS,KAAK,aAAa;oBACxD,CAAC,CAAC,IAAI;oBACN,CAAC,CAAC,KAAK;aACT,CAAC;QACH,CAAC,CAAC,CAAC;QAEJ,MAAM;aACJ,MAAM,CACN,CAAC,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5B,QAAQ,KAAK,YAAY,IAAI,UAAU,IAAI,IAAI,CAChD;aACA,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,EAAE,EAAE;YAC5C,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,GAAG,UAAW,CAAC;YACzD,MAAM,sBAAsB,GAC3B,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE,IAAI,CAAC;YACzD,MAAM,aAAa,GAAG,sBAAsB,IAAI,kBAAkB,CAAC;YAEnE,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YACvC,WAAW,CAAC,SAAS,CAAC,GAAG;gBACxB,KAAK,EAAE,oBAAoB;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,SAAS,EAAE,CAAC,QAAQ;gBACpB,KAAK,EAAE,UAAU,GAAG,GAAG,GAAG,eAAe,CAAC,aAAa,CAAC;aACxD,CAAC;QACH,CAAC,CAAC,CAAC;QAEJ,iBAAiB,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;QAE9C,IAAI,SAAS,GAAsC;YAClD,WAAW,EAAE,IAAI;YACjB,KAAK,EAAE,UAAU,GAAG,GAAG,GAAG,YAAY;SACtC,CAAC;QACF,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAE1D,EAAE,CAAC;YACH,SAAS,GAAG,EAAE,GAAG,SAAS,EAAE,GAAG,kBAAkB,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QACvE,CAAC;QAED,eAAe,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAgB;QAE9B,QAAQ,EAAE,KAAK;QACf,gBAAgB,EAAE,UAAU,GAAG,WAAW;QAC1C,UAAU,EAAE,yBAAyB;QACrC,CAAC,UAAU,CAAC,EAAE;YAEb,MAAM,EAAE,UAAU;YAClB,wBAAwB,EAAE,IAAI;YAC9B,mBAAmB,EAAE,2DAA2D,UAAU,EAAE;YAC5F,uBAAuB,EACtB,0FAA0F;YAC3F,qBAAqB,EAAE,OAAO;YAC9B,GAAG,iBAAiB;YACpB,CAAC,UAAU,CAAC,EAAE,eAAe;SAC7B;KACD,CAAC;IAEF,OAAO,SAAS,CAAC;AAClB,CAAC,CAAC;AAEF,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/out/odata-metadata/open-api-specification-generator.d.ts

@@ -0,0 +1,2 @@
+import type { generateODataMetadata } from './odata-metadata-generator.js';
+export declare const generateODataMetadataAsOpenApi: (odataCsdl: ReturnType<typeof generateODataMetadata>, versionBasePathUrl?: string, hostname?: string) => any;

package/out/odata-metadata/open-api-specification-generator.js

@@ -0,0 +1,50 @@
+import * as odataMetadata from 'odata-openapi';
+import _ from 'lodash';
+export const generateODataMetadataAsOpenApi = (odataCsdl, versionBasePathUrl = '', hostname = '') => {
+    const openAPIJson = odataMetadata.csdl2openapi(odataCsdl, {
+        scheme: 'https',
+        host: hostname,
+        basePath: versionBasePathUrl,
+        diagram: false,
+        maxLevels: 5,
+    });
+    const parameters = openAPIJson?.components?.parameters;
+    parameters['filter'] = {
+        name: '$filter',
+        description: 'Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)',
+        in: 'query',
+        schema: {
+            type: 'string',
+        },
+    };
+    for (const idx of Object.keys(openAPIJson.paths)) {
+        const properties = openAPIJson?.paths[idx]?.get?.responses?.['200']?.content?.['application/json']?.schema?.properties;
+        if (properties?.value) {
+            properties['d'] = properties.value;
+            delete properties.value;
+        }
+        if (properties?.['@odata.count']) {
+            delete properties['@odata.count'];
+        }
+        const entityCollectionPath = openAPIJson?.paths[idx];
+        const singleEntityPath = openAPIJson?.paths[idx + '({id})'];
+        if (entityCollectionPath != null && singleEntityPath != null) {
+            const genericFilterParameterRef = {
+                $ref: '#/components/parameters/filter',
+            };
+            for (const action of ['delete', 'patch']) {
+                entityCollectionPath[action] = _.clone(singleEntityPath?.[action]);
+                if (entityCollectionPath[action]) {
+                    entityCollectionPath[action]['parameters'] = [
+                        genericFilterParameterRef,
+                    ];
+                }
+            }
+        }
+    }
+    if (openAPIJson?.paths['/$batch']) {
+        delete openAPIJson.paths['/$batch'];
+    }
+    return openAPIJson;
+};
+//# sourceMappingURL=open-api-specification-generator.js.map

package/out/odata-metadata/open-api-specification-generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open-api-specification-generator.js","sourceRoot":"","sources":["../../src/odata-metadata/open-api-specification-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,eAAe,CAAC;AAE/C,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAC7C,SAAmD,EACnD,kBAAkB,GAAG,EAAE,EACvB,QAAQ,GAAG,EAAE,EACZ,EAAE;IAEH,MAAM,WAAW,GAAQ,aAAa,CAAC,YAAY,CAAC,SAAS,EAAE;QAC9D,MAAM,EAAE,OAAO;QACf,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,kBAAkB;QAC5B,OAAO,EAAE,KAAK;QACd,SAAS,EAAE,CAAC;KACZ,CAAC,CAAC;IA2BH,MAAM,UAAU,GAAG,WAAW,EAAE,UAAU,EAAE,UAAU,CAAC;IACvD,UAAU,CAAC,QAAQ,CAAC,GAAG;QACtB,IAAI,EAAE,SAAS;QACf,WAAW,EACV,4JAA4J;QAC7J,EAAE,EAAE,OAAO;QACX,MAAM,EAAE;YACP,IAAI,EAAE,QAAQ;SACd;KACD,CAAC;IAEF,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QAElD,MAAM,UAAU,GACf,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAC1D,kBAAkB,CAClB,EAAE,MAAM,EAAE,UAAU,CAAC;QACvB,IAAI,UAAU,EAAE,KAAK,EAAE,CAAC;YACvB,UAAU,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC;YACnC,OAAO,UAAU,CAAC,KAAK,CAAC;QACzB,CAAC;QAGD,IAAI,UAAU,EAAE,CAAC,cAAc,CAAC,EAAE,CAAC;YAClC,OAAO,UAAU,CAAC,cAAc,CAAC,CAAC;QACnC,CAAC;QAKD,MAAM,oBAAoB,GAAG,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,gBAAgB,GAAG,WAAW,EAAE,KAAK,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;QAC5D,IAAI,oBAAoB,IAAI,IAAI,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;YAC9D,MAAM,yBAAyB,GAAG;gBACjC,IAAI,EAAE,gCAAgC;aACtC,CAAC;YACF,KAAK,MAAM,MAAM,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;gBAC1C,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBACnE,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;oBAClC,oBAAoB,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,GAAG;wBAC5C,yBAAyB;qBACzB,CAAC;gBACH,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAID,IAAI,WAAW,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACnC,OAAO,WAAW,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,WAAW,CAAC;AACpB,CAAC,CAAC"}

package/out/sbvr-api/permissions.d.ts

@@ -1,8 +1,10 @@
 import type AuthModel from './user.js';
 import './express-extension.js';
 import type Express from 'express';
+import type { ODataBinds } from '@balena/odata-parser';
 import type { Tx } from '../database-layer/db.js';
 import type { ApiKey, User } from '../sbvr-api/sbvr-utils.js';
+import type { Dictionary } from './common-types.js';
 import { type HookReq } from './hooks.js';
 import { PermissionError, PermissionParsingError } from './errors.js';
 import { type ODataRequest } from './uri-parser.js';
@@ -27,6 +29,7 @@ type MappedNestedCheck<T extends NestedCheck<I>, I, O> = T extends NestedCheckOr
 export declare function nestedCheck<I extends string, O>(check: I, stringCallback: (s: string) => O): O;
 export declare function nestedCheck<I extends boolean, O>(check: I, stringCallback: (s: string) => O): boolean;
 export declare function nestedCheck<I extends NonNullable<unknown>, O>(check: NestedCheck<I>, stringCallback: (s: string) => O): Exclude<I, string> | O | MappedNestedCheck<typeof check, I, O>;
+export type PermissionLookup = Dictionary<true | string[]>;
 export declare const checkPassword: (username: string, password: string) => Promise<{
     id: number;
     actor: number;
@@ -50,6 +53,7 @@ export declare const customApiKeyMiddleware: (paramName?: string) => (req: HookR
 export declare const apiKeyMiddleware: (req: HookReq | Express.Request, _res?: Express.Response, next?: Express.NextFunction) => Promise<void>;
 export declare const checkPermissions: (req: PermissionReq, actionList: PermissionCheck, resourceName?: string, vocabulary?: string) => Promise<boolean | NestedCheck<string>>;
 export declare const checkPermissionsMiddleware: (action: PermissionCheck) => Express.RequestHandler;
+export declare const getReqPermissions: (req: PermissionReq, odataBinds?: ODataBinds) => Promise<PermissionLookup>;
 export declare const addPermissions: (req: PermissionReq, request: ODataRequest & {
     permissionType?: PermissionCheck;
 }) => Promise<void>;

package/out/sbvr-api/permissions.js

@@ -1055,7 +1055,7 @@ const getGuestPermissions = memoize(async () => {
     guestPermissionsInitialized = true;
     return guestPermissions;
 }, { promise: true });
-const getReqPermissions = async (req, odataBinds = []) => {
+export const getReqPermissions = async (req, odataBinds = []) => {
     const guestPermissions = await (async () => {
         if (guestPermissionsInitialized === false &&
             (req.user === root.user || req.user === rootRead.user)) {