softkave-node-utils 0.1.0

package/build/src/endpoints/endpoints.mddoc.js

@@ -0,0 +1,437 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mddocEndpointHttpResponseItems = exports.fReusables = exports.mddocEndpointHttpHeaderItems = exports.mddocEndpointStatusCodes = void 0;
+const lodash_1 = require("lodash");
+const nanoid_1 = require("nanoid");
+const softkave_js_utils_1 = require("softkave-js-utils");
+const resourceTypes_1 = require("../definitions/resourceTypes");
+const mddoc_1 = require("../mddoc/mddoc");
+const constants_1 = require("./constants");
+const types_1 = require("./types");
+exports.mddocEndpointStatusCodes = {
+    success: `${constants_1.kEndpointConstants.httpStatusCode.ok}`,
+    error: '4XX or 5XX',
+};
+const requestHeaderItem_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('HTTP JSON request content type')
+    .setExample('application/json');
+const requestHeaderItem_MultipartFormdataContentType = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('HTTP multipart form-data request content type')
+    .setExample('multipart/form-data')
+    .setValid(['multipart/form-data']);
+const responseHeaderItem_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('HTTP JSON response content type')
+    .setExample('application/json');
+const responseHeaderItem_ContentLength = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('HTTP response content length in bytes');
+const requestHeaderItem_Authorization = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Access token')
+    .setExample('Bearer <token>');
+const requestHeaderItem_ContentType = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('HTTP request content type')
+    .setExample('application/json or multipart/form-data');
+const requestHeaders_AuthRequired_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_Authorization,
+    }),
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_JsonContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthRequired_JsonContentType');
+const requestHeaders_AuthOptional_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: requestHeaderItem_Authorization,
+    }),
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_JsonContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthOptional_JsonContentType');
+const requestHeaders_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_JsonContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_JsonContentType');
+const requestHeaders_AuthRequired_MultipartContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_Authorization,
+    }),
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_MultipartFormdataContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthRequired_MultipartContentType');
+const requestHeaders_AuthOptional_MultipartContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: requestHeaderItem_Authorization,
+    }),
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_MultipartFormdataContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthOptional_MultipartContentType');
+const requestHeaders_MultipartContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_MultipartFormdataContentType,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_MultipartContentType');
+const requestHeaders_AuthRequired = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: requestHeaderItem_Authorization,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthRequired');
+const requestHeaders_AuthOptional = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    Authorization: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: requestHeaderItem_Authorization,
+    }),
+})
+    .setName('HttpEndpointRequestHeaders_AuthOptional');
+const responseHeaders_JsonContentType = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setFields({
+    'Content-Type': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: responseHeaderItem_JsonContentType,
+    }),
+    'Content-Length': mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: responseHeaderItem_ContentLength,
+    }),
+})
+    .setName('HttpEndpointResponseHeaders_ContentType_ContentLength');
+exports.mddocEndpointHttpHeaderItems = {
+    requestHeaderItem_Authorization,
+    requestHeaderItem_ContentType,
+    responseHeaderItem_JsonContentType,
+    requestHeaderItem_JsonContentType,
+    requestHeaderItem_MultipartFormdataContentType,
+    requestHeaders_AuthRequired_JsonContentType,
+    requestHeaders_AuthRequired,
+    requestHeaders_JsonContentType,
+    requestHeaders_AuthOptional,
+    requestHeaders_MultipartContentType,
+    requestHeaders_AuthOptional_MultipartContentType,
+    requestHeaders_AuthRequired_MultipartContentType,
+    requestHeaders_AuthOptional_JsonContentType,
+    responseHeaderItem_ContentLength,
+    responseHeaders_JsonContentType,
+};
+const nullValue = mddoc_1.mddocConstruct.constructFieldNull();
+const makeAgent = (agentTypeList) => {
+    return mddoc_1.mddocConstruct
+        .constructFieldObject()
+        .setName('Agent')
+        .setFields({
+        agentId: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: mddoc_1.mddocConstruct
+                .constructFieldString()
+                .setDescription('Agent ID. Possible agents are users and agent tokens'),
+        }),
+        agentType: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: mddoc_1.mddocConstruct
+                .constructFieldString()
+                .setDescription('Agent type')
+                .setExample((0, lodash_1.first)(agentTypeList))
+                .setValid(agentTypeList)
+                .setEnumName('AgentType'),
+        }),
+    });
+};
+const date = mddoc_1.mddocConstruct
+    .constructFieldNumber()
+    .setDescription('UTC timestamp in milliseconds');
+const dateOrNull = mddoc_1.mddocConstruct
+    .constructFieldOrCombination()
+    .setTypes([date, nullValue]);
+const id = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Resource ID')
+    .setExample(`${resourceTypes_1.kResourceTypeShortNames[resourceTypes_1.kFimidaraResourceType.Job]}${softkave_js_utils_1.kSoftkaveJsUtilsConstants.resource.shortNameIdSeparator}${(0, nanoid_1.customAlphabet)('0')()}`);
+const idList = mddoc_1.mddocConstruct
+    .constructFieldArray()
+    .setType(id)
+    .setDescription('List of resource IDs');
+const idOrList = mddoc_1.mddocConstruct
+    .constructFieldOrCombination()
+    .setTypes([id, idList]);
+const jobId = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Long running job ID')
+    .setExample(`${resourceTypes_1.kResourceTypeShortNames[resourceTypes_1.kFimidaraResourceType.Job]}${softkave_js_utils_1.kSoftkaveJsUtilsConstants.resource.shortNameIdSeparator}${(0, nanoid_1.customAlphabet)('0')()}`);
+const jobIds = mddoc_1.mddocConstruct
+    .constructFieldArray()
+    .setDescription('Multiple long running job IDs')
+    .setType(jobId);
+const name = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Name, case insensitive');
+const description = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Description');
+const expires = mddoc_1.mddocConstruct
+    .constructFieldNumber()
+    .setDescription('Expiration date');
+const duration = mddoc_1.mddocConstruct
+    .constructFieldNumber()
+    .setDescription('Time duration in milliseconds, for example, 1000 for 1 second');
+const tokenString = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('JWT token string');
+const providedResourceId = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Resource ID provided by you')
+    .setMax(constants_1.kEndpointConstants.providedResourceIdMaxLength);
+const providedResourceIdOrNull = mddoc_1.mddocConstruct
+    .constructFieldOrCombination()
+    .setTypes([providedResourceId, nullValue]);
+const firstName = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('First name')
+    .setExample('Jesus');
+const lastName = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Last name')
+    .setExample('Christ');
+const password = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Password');
+const emailAddress = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Email address, case insensitive')
+    .setExample('my-email-address@email-domain.com');
+const page = mddoc_1.mddocConstruct
+    .constructFieldNumber()
+    .setDescription('Paginated list page number. Page is zero-based, meaning page numbering starts from 0, 1, 2, 3, ..')
+    .setExample(0)
+    .setMin(constants_1.kEndpointConstants.minPage);
+const pageSize = mddoc_1.mddocConstruct
+    .constructFieldNumber()
+    .setDescription('Paginated list page size')
+    .setExample(10)
+    .setMin(constants_1.kEndpointConstants.minPageSize)
+    .setMax(constants_1.kEndpointConstants.maxPageSize);
+const resultNoteCode = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Endpoint result or error note code')
+    .setExample(types_1.kEndpointResultNoteCodeMap.unknown)
+    .setValid(Object.values(types_1.kEndpointResultNoteCodeMap))
+    .setEnumName('EndpointResultNoteCode');
+const resultNoteMessage = mddoc_1.mddocConstruct
+    .constructFieldString()
+    .setDescription('Endpoint result or error note message')
+    .setExample("Some mounts in the requested folder's mount chain do not support operation abc");
+const resultNote = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('EndpointResultNote')
+    .setFields({
+    code: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: resultNoteCode,
+    }),
+    message: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: resultNoteMessage,
+    }),
+});
+const resultNoteList = mddoc_1.mddocConstruct
+    .constructFieldArray()
+    .setType(resultNote);
+const makeResourceParts = (agentTypeList) => {
+    return {
+        resourceId: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: id,
+        }),
+        createdBy: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: false,
+            data: makeAgent(agentTypeList),
+        }),
+        createdAt: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: date,
+        }),
+        lastUpdatedBy: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: false,
+            data: makeAgent(agentTypeList),
+        }),
+        lastUpdatedAt: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: date,
+        }),
+        isDeleted: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: true,
+            data: mddoc_1.mddocConstruct.constructFieldBoolean(),
+        }),
+        deletedAt: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: false,
+            data: date,
+        }),
+        deletedBy: mddoc_1.mddocConstruct.constructFieldObjectField({
+            required: false,
+            data: makeAgent(agentTypeList),
+        }),
+    };
+};
+exports.fReusables = {
+    makeAgent,
+    date,
+    id,
+    idList,
+    name,
+    description,
+    expires,
+    duration,
+    tokenString,
+    providedResourceId,
+    idOrList,
+    firstName,
+    lastName,
+    emailAddress,
+    page,
+    pageSize,
+    jobId,
+    password,
+    providedResourceIdOrNull,
+    dateOrNull,
+    nullValue,
+    resultNote,
+    resultNoteCode,
+    resultNoteList,
+    makeResourceParts,
+    jobIds,
+};
+const errorObject = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('OperationError')
+    .setFields({
+    name: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: mddoc_1.mddocConstruct
+            .constructFieldString()
+            .setDescription('Error name')
+            .setExample('ValidationError'),
+    }),
+    message: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: mddoc_1.mddocConstruct
+            .constructFieldString()
+            .setDescription('Error message')
+            .setExample('Workspace name is invalid'),
+    }),
+    action: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: mddoc_1.mddocConstruct
+            .constructFieldString()
+            .setDescription('Recommended action')
+            .setValid(Object.values(types_1.ServerRecommendedActionsMap)),
+    }),
+    field: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: mddoc_1.mddocConstruct
+            .constructFieldString()
+            .setExample('workspace.innerField.secondInnerField')
+            .setDescription('Invalid field failing validation when error is ValidationError'),
+    }),
+    notes: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: resultNoteList,
+    }),
+});
+const errorResponseBody = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('EndpointErrorResult')
+    .setFields({
+    errors: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: mddoc_1.mddocConstruct
+            .constructFieldArray()
+            .setType(errorObject)
+            .setDescription('Endpoint call response errors'),
+    }),
+})
+    .setDescription('Endpoint error result');
+const emptySuccessResponseBody = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('EmptyEndpointResult')
+    .setFields({})
+    .setDescription('Empty endpoint success result');
+const longRunningJobResponseBody = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('LongRunningJobResult')
+    .setFields({
+    jobId: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: false,
+        data: jobId,
+    }),
+})
+    .setDescription('Long running job endpoint success result');
+const multipleLongRunningJobResponseBody = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('MultipleLongRunningJobResult')
+    .setFields({
+    jobIds: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: jobIds,
+    }),
+})
+    .setDescription('Long running job endpoint success result');
+const countResponseBody = mddoc_1.mddocConstruct
+    .constructFieldObject()
+    .setName('CountItemsResult')
+    .setFields({
+    count: mddoc_1.mddocConstruct.constructFieldObjectField({
+        required: true,
+        data: mddoc_1.mddocConstruct
+            .constructFieldNumber()
+            .setDescription('Resource count'),
+    }),
+})
+    .setDescription('Count endpoint success result');
+exports.mddocEndpointHttpResponseItems = {
+    errorResponseBody,
+    emptySuccessResponseBody,
+    longRunningJobResponseBody,
+    countResponseBody,
+    multipleLongRunningJobResponseBody,
+};
+//# sourceMappingURL=endpoints.mddoc.js.map

package/build/src/endpoints/endpoints.mddoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"endpoints.mddoc.js","sourceRoot":"","sources":["../../../src/endpoints/endpoints.mddoc.ts"],"names":[],"mappings":";;;AAAA,mCAA6B;AAC7B,mCAAsC;AACtC,yDAAuE;AAGvE,gEAGsC;AAEtC,0CAAoE;AACpE,2CAA+C;AAE/C,mCAYiB;AAEJ,QAAA,wBAAwB,GAAG;IACtC,OAAO,EAAE,GAAG,8BAAkB,CAAC,cAAc,CAAC,EAAE,EAAE;IAClD,KAAK,EAAE,YAAY;CACX,CAAC;AAEX,MAAM,iCAAiC,GAAG,sBAAc;KACrD,oBAAoB,EAAE;KACtB,cAAc,CAAC,gCAAgC,CAAC;KAChD,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAClC,MAAM,8CAA8C,GAAG,sBAAc;KAClE,oBAAoB,EAAE;KACtB,cAAc,CAAC,+CAA+C,CAAC;KAC/D,UAAU,CAAC,qBAAqB,CAAC;KACjC,QAAQ,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC;AACrC,MAAM,kCAAkC,GAAG,sBAAc;KACtD,oBAAoB,EAAE;KACtB,cAAc,CAAC,iCAAiC,CAAC;KACjD,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAClC,MAAM,gCAAgC,GAAG,sBAAc;KACpD,oBAAoB,EAAE;KACtB,cAAc,CAAC,uCAAuC,CAAC,CAAC;AAC3D,MAAM,+BAA+B,GAAG,sBAAc;KACnD,oBAAoB,EAAE;KACtB,cAAc,CAAC,cAAc,CAAC;KAC9B,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAChC,MAAM,6BAA6B,GAAG,sBAAc;KACjD,oBAAoB,EAAE;KACtB,cAAc,CAAC,2BAA2B,CAAC;KAC3C,UAAU,CAAC,yCAAyC,CAAC,CAAC;AAEzD,MAAM,2CAA2C,GAAG,sBAAc;KAC/D,oBAAoB,EAAuD;KAC3E,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,+BAA+B;KACtC,CAAC;IACF,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,iCAAiC;KACxC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,yDAAyD,CAAC,CAAC;AACtE,MAAM,2CAA2C,GAAG,sBAAc;KAC/D,oBAAoB,EAAuD;KAC3E,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,+BAA+B;KACtC,CAAC;IACF,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,iCAAiC;KACxC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,yDAAyD,CAAC,CAAC;AACtE,MAAM,8BAA8B,GAAG,sBAAc;KAClD,oBAAoB,EAA0C;KAC9D,SAAS,CAAC;IACT,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,iCAAiC;KACxC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,4CAA4C,CAAC,CAAC;AACzD,MAAM,gDAAgD,GAAG,sBAAc;KACpE,oBAAoB,EAAuD;KAC3E,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,+BAA+B;KACtC,CAAC;IACF,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,8CAA8C;KACrD,CAAC;CACH,CAAC;KACD,OAAO,CAAC,8DAA8D,CAAC,CAAC;AAC3E,MAAM,gDAAgD,GAAG,sBAAc;KACpE,oBAAoB,EAAuD;KAC3E,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,+BAA+B;KACtC,CAAC;IACF,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,8CAA8C;KACrD,CAAC;CACH,CAAC;KACD,OAAO,CAAC,8DAA8D,CAAC,CAAC;AAC3E,MAAM,mCAAmC,GAAG,sBAAc;KACvD,oBAAoB,EAA0C;KAC9D,SAAS,CAAC;IACT,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,8CAA8C;KACrD,CAAC;CACH,CAAC;KACD,OAAO,CAAC,iDAAiD,CAAC,CAAC;AAC9D,MAAM,2BAA2B,GAAG,sBAAc;KAC/C,oBAAoB,EAA2C;KAC/D,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,+BAA+B;KACtC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,yCAAyC,CAAC,CAAC;AACtD,MAAM,2BAA2B,GAAG,sBAAc;KAC/C,oBAAoB,EAA2C;KAC/D,SAAS,CAAC;IACT,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACtD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,+BAA+B;KACtC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,yCAAyC,CAAC,CAAC;AACtD,MAAM,+BAA+B,GAAG,sBAAc;KACnD,oBAAoB,EAAyD;KAC7E,SAAS,CAAC;IACT,cAAc,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACvD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,kCAAkC;KACzC,CAAC;IACF,gBAAgB,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QACzD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,gCAAgC;KACvC,CAAC;CACH,CAAC;KACD,OAAO,CAAC,uDAAuD,CAAC,CAAC;AAEvD,QAAA,4BAA4B,GAAG;IAC1C,+BAA+B;IAC/B,6BAA6B;IAC7B,kCAAkC;IAClC,iCAAiC;IACjC,8CAA8C;IAC9C,2CAA2C;IAC3C,2BAA2B;IAC3B,8BAA8B;IAC9B,2BAA2B;IAC3B,mCAAmC;IACnC,gDAAgD;IAChD,gDAAgD;IAChD,2CAA2C;IAC3C,gCAAgC;IAChC,+BAA+B;CAChC,CAAC;AAEF,MAAM,SAAS,GAAG,sBAAc,CAAC,kBAAkB,EAAE,CAAC;AACtD,MAAM,SAAS,GAAG,CAAC,aAAuB,EAAE,EAAE;IAC5C,OAAO,sBAAc;SAClB,oBAAoB,EAAe;SACnC,OAAO,CAAC,OAAO,CAAC;SAChB,SAAS,CAAC;QACT,OAAO,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAChD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,sBAAc;iBACjB,oBAAoB,EAAE;iBACtB,cAAc,CACb,sDAAsD,CACvD;SACJ,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,sBAAc;iBACjB,oBAAoB,EAAE;iBACtB,cAAc,CAAC,YAAY,CAAC;iBAC5B,UAAU,CAAC,IAAA,cAAK,EAAC,aAAa,CAAC,CAAC;iBAChC,QAAQ,CAAC,aAAa,CAAC;iBACvB,WAAW,CAAC,WAAW,CAAC;SAC5B,CAAC;KACH,CAAC,CAAC;AACP,CAAC,CAAC;AACF,MAAM,IAAI,GAAG,sBAAc;KACxB,oBAAoB,EAAE;KACtB,cAAc,CAAC,+BAA+B,CAAC,CAAC;AACnD,MAAM,UAAU,GAAG,sBAAc;KAC9B,2BAA2B,EAAiB;KAC5C,QAAQ,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;AAC/B,MAAM,EAAE,GAAG,sBAAc;KACtB,oBAAoB,EAAE;KACtB,cAAc,CAAC,aAAa,CAAC;KAC7B,UAAU,CACT,GAAG,uCAAuB,CAAC,qCAAqB,CAAC,GAAG,CAAC,GACnD,6CAAyB,CAAC,QAAQ,CAAC,oBACrC,GAAG,IAAA,uBAAc,EAAC,GAAG,CAAC,EAAE,EAAE,CAC3B,CAAC;AACJ,MAAM,MAAM,GAAG,sBAAc;KAC1B,mBAAmB,EAAU;KAC7B,OAAO,CAAC,EAAE,CAAC;KACX,cAAc,CAAC,sBAAsB,CAAC,CAAC;AAC1C,MAAM,QAAQ,GAAG,sBAAc;KAC5B,2BAA2B,EAAqB;KAChD,QAAQ,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAC;AAC1B,MAAM,KAAK,GAAG,sBAAc;KACzB,oBAAoB,EAAE;KACtB,cAAc,CAAC,qBAAqB,CAAC;KACrC,UAAU,CACT,GAAG,uCAAuB,CAAC,qCAAqB,CAAC,GAAG,CAAC,GACnD,6CAAyB,CAAC,QAAQ,CAAC,oBACrC,GAAG,IAAA,uBAAc,EAAC,GAAG,CAAC,EAAE,EAAE,CAC3B,CAAC;AACJ,MAAM,MAAM,GAAG,sBAAc;KAC1B,mBAAmB,EAAU;KAC7B,cAAc,CAAC,+BAA+B,CAAC;KAC/C,OAAO,CAAC,KAAK,CAAC,CAAC;AAClB,MAAM,IAAI,GAAG,sBAAc;KACxB,oBAAoB,EAAE;KACtB,cAAc,CAAC,wBAAwB,CAAC,CAAC;AAC5C,MAAM,WAAW,GAAG,sBAAc;KAC/B,oBAAoB,EAAE;KACtB,cAAc,CAAC,aAAa,CAAC,CAAC;AACjC,MAAM,OAAO,GAAG,sBAAc;KAC3B,oBAAoB,EAAE;KACtB,cAAc,CAAC,iBAAiB,CAAC,CAAC;AACrC,MAAM,QAAQ,GAAG,sBAAc;KAC5B,oBAAoB,EAAE;KACtB,cAAc,CACb,+DAA+D,CAChE,CAAC;AACJ,MAAM,WAAW,GAAG,sBAAc;KAC/B,oBAAoB,EAAE;KACtB,cAAc,CAAC,kBAAkB,CAAC,CAAC;AACtC,MAAM,kBAAkB,GAAG,sBAAc;KACtC,oBAAoB,EAAE;KACtB,cAAc,CAAC,6BAA6B,CAAC;KAC7C,MAAM,CAAC,8BAAkB,CAAC,2BAA2B,CAAC,CAAC;AAC1D,MAAM,wBAAwB,GAAG,sBAAc;KAC5C,2BAA2B,EAAiB;KAC5C,QAAQ,CAAC,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC,CAAC;AAC7C,MAAM,SAAS,GAAG,sBAAc;KAC7B,oBAAoB,EAAE;KACtB,cAAc,CAAC,YAAY,CAAC;KAC5B,UAAU,CAAC,OAAO,CAAC,CAAC;AACvB,MAAM,QAAQ,GAAG,sBAAc;KAC5B,oBAAoB,EAAE;KACtB,cAAc,CAAC,WAAW,CAAC;KAC3B,UAAU,CAAC,QAAQ,CAAC,CAAC;AACxB,MAAM,QAAQ,GAAG,sBAAc;KAC5B,oBAAoB,EAAE;KACtB,cAAc,CAAC,UAAU,CAAC,CAAC;AAC9B,MAAM,YAAY,GAAG,sBAAc;KAChC,oBAAoB,EAAE;KACtB,cAAc,CAAC,iCAAiC,CAAC;KACjD,UAAU,CAAC,mCAAmC,CAAC,CAAC;AACnD,MAAM,IAAI,GAAG,sBAAc;KACxB,oBAAoB,EAAE;KACtB,cAAc,CACb,mGAAmG,CACpG;KACA,UAAU,CAAC,CAAC,CAAC;KACb,MAAM,CAAC,8BAAkB,CAAC,OAAO,CAAC,CAAC;AACtC,MAAM,QAAQ,GAAG,sBAAc;KAC5B,oBAAoB,EAAE;KACtB,cAAc,CAAC,0BAA0B,CAAC;KAC1C,UAAU,CAAC,EAAE,CAAC;KACd,MAAM,CAAC,8BAAkB,CAAC,WAAW,CAAC;KACtC,MAAM,CAAC,8BAAkB,CAAC,WAAW,CAAC,CAAC;AAC1C,MAAM,cAAc,GAAG,sBAAc;KAClC,oBAAoB,EAAE;KACtB,cAAc,CAAC,oCAAoC,CAAC;KACpD,UAAU,CAAC,kCAA0B,CAAC,OAAO,CAAC;KAC9C,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,kCAA0B,CAAC,CAAC;KACnD,WAAW,CAAC,wBAAwB,CAAC,CAAC;AACzC,MAAM,iBAAiB,GAAG,sBAAc;KACrC,oBAAoB,EAAE;KACtB,cAAc,CAAC,uCAAuC,CAAC;KACvD,UAAU,CACT,gFAAgF,CACjF,CAAC;AACJ,MAAM,UAAU,GAAG,sBAAc;KAC9B,oBAAoB,EAAsB;KAC1C,OAAO,CAAC,oBAAoB,CAAC;KAC7B,SAAS,CAAC;IACT,IAAI,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC7C,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,cAAc;KACrB,CAAC;IACF,OAAO,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAChD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,iBAAiB;KACxB,CAAC;CACH,CAAC,CAAC;AACL,MAAM,cAAc,GAAG,sBAAc;KAClC,mBAAmB,EAAsB;KACzC,OAAO,CAAC,UAAU,CAAC,CAAC;AACvB,MAAM,iBAAiB,GAAG,CACxB,aAAuB,EACe,EAAE;IACxC,OAAO;QACL,UAAU,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YACnD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,EAAE;SACT,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;SAC/B,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI;SACX,CAAC;QACF,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YACtD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;SAC/B,CAAC;QACF,aAAa,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YACtD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,IAAI;SACX,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,sBAAc,CAAC,qBAAqB,EAAE;SAC7C,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,IAAI;SACX,CAAC;QACF,SAAS,EAAE,sBAAc,CAAC,yBAAyB,CAAC;YAClD,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC;SAC/B,CAAC;KACH,CAAC;AACJ,CAAC,CAAC;AAEW,QAAA,UAAU,GAAG;IACxB,SAAS;IACT,IAAI;IACJ,EAAE;IACF,MAAM;IACN,IAAI;IACJ,WAAW;IACX,OAAO;IACP,QAAQ;IACR,WAAW;IACX,kBAAkB;IAClB,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,YAAY;IACZ,IAAI;IACJ,QAAQ;IACR,KAAK;IACL,QAAQ;IACR,wBAAwB;IACxB,UAAU;IACV,SAAS;IACT,UAAU;IACV,cAAc;IACd,cAAc;IACd,iBAAiB;IACjB,MAAM;CACP,CAAC;AAEF,MAAM,WAAW,GAAG,sBAAc;KAC/B,oBAAoB,EAAyB;KAC7C,OAAO,CAAC,gBAAgB,CAAC;KACzB,SAAS,CAAC;IACT,IAAI,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC7C,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,sBAAc;aACjB,oBAAoB,EAAE;aACtB,cAAc,CAAC,YAAY,CAAC;aAC5B,UAAU,CAAC,iBAAiB,CAAC;KACjC,CAAC;IACF,OAAO,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAChD,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,sBAAc;aACjB,oBAAoB,EAAE;aACtB,cAAc,CAAC,eAAe,CAAC;aAC/B,UAAU,CAAC,2BAA2B,CAAC;KAC3C,CAAC;IACF,MAAM,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC/C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,sBAAc;aACjB,oBAAoB,EAAE;aACtB,cAAc,CAAC,oBAAoB,CAAC;aACpC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,mCAA2B,CAAC,CAAC;KACxD,CAAC;IACF,KAAK,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC9C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,sBAAc;aACjB,oBAAoB,EAAE;aACtB,UAAU,CAAC,uCAAuC,CAAC;aACnD,cAAc,CACb,gEAAgE,CACjE;KACJ,CAAC;IACF,KAAK,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC9C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,cAAc;KACrB,CAAC;CACH,CAAC,CAAC;AAEL,MAAM,iBAAiB,GAAG,sBAAc;KACrC,oBAAoB,EAAsB;KAC1C,OAAO,CAAC,qBAAqB,CAAC;KAC9B,SAAS,CAAC;IACT,MAAM,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC/C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,sBAAc;aACjB,mBAAmB,EAAyB;aAC5C,OAAO,CAAC,WAAW,CAAC;aACpB,cAAc,CAAC,+BAA+B,CAAC;KACnD,CAAC;CACH,CAAC;KACD,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAE3C,MAAM,wBAAwB,GAAG,sBAAc;KAC5C,oBAAoB,EAAa;KACjC,OAAO,CAAC,qBAAqB,CAAC;KAC9B,SAAS,CAAC,EAAE,CAAC;KACb,cAAc,CAAC,+BAA+B,CAAC,CAAC;AAEnD,MAAM,0BAA0B,GAAG,sBAAc;KAC9C,oBAAoB,EAAwB;KAC5C,OAAO,CAAC,sBAAsB,CAAC;KAC/B,SAAS,CAAC;IACT,KAAK,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC9C,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,KAAK;KACZ,CAAC;CACH,CAAC;KACD,cAAc,CAAC,0CAA0C,CAAC,CAAC;AAE9D,MAAM,kCAAkC,GAAG,sBAAc;KACtD,oBAAoB,EAAgC;KACpD,OAAO,CAAC,8BAA8B,CAAC;KACvC,SAAS,CAAC;IACT,MAAM,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC/C,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,MAAM;KACb,CAAC;CACH,CAAC;KACD,cAAc,CAAC,0CAA0C,CAAC,CAAC;AAE9D,MAAM,iBAAiB,GAAG,sBAAc;KACrC,oBAAoB,EAA4B;KAChD,OAAO,CAAC,kBAAkB,CAAC;KAC3B,SAAS,CAAC;IACT,KAAK,EAAE,sBAAc,CAAC,yBAAyB,CAAC;QAC9C,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,sBAAc;aACjB,oBAAoB,EAAE;aACtB,cAAc,CAAC,gBAAgB,CAAC;KACpC,CAAC;CACH,CAAC;KACD,cAAc,CAAC,+BAA+B,CAAC,CAAC;AAEtC,QAAA,8BAA8B,GAAG;IAC5C,iBAAiB;IACjB,wBAAwB;IACxB,0BAA0B;IAC1B,iBAAiB;IACjB,kCAAkC;CACnC,CAAC"}

package/build/src/endpoints/extractors.d.ts

@@ -0,0 +1,9 @@
+import { ExtractFieldsFrom } from 'softkave-js-utils';
+import { PublicAgent } from '../definitions/agent';
+import { PublicResource } from '../definitions/resource';
+export declare const agentExtractor: <T1 extends PublicAgent>(data: Partial<Record<keyof T1, any>>) => PublicAgent;
+export declare const agentExtractorIfPresent: <T1 extends PublicAgent>(data?: Partial<Record<keyof T1, any>> | undefined) => PublicAgent | undefined;
+export declare const agentListExtractor: <T1 extends PublicAgent>(data: Partial<Record<keyof T1, any>>[]) => PublicAgent[];
+export declare const resourceFields: ExtractFieldsFrom<PublicResource>;
+export declare const resourceExtractor: <T1 extends import("../definitions/agent").ConvertAgentToPublicAgent<import("../definitions/resource").Resource>>(data: Partial<Record<keyof T1, any>>) => import("../definitions/agent").ConvertAgentToPublicAgent<import("../definitions/resource").Resource>;
+export declare const resourceListExtractor: <T1 extends import("../definitions/agent").ConvertAgentToPublicAgent<import("../definitions/resource").Resource>>(data: Partial<Record<keyof T1, any>>[]) => import("../definitions/agent").ConvertAgentToPublicAgent<import("../definitions/resource").Resource>[];

package/build/src/endpoints/extractors.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resourceListExtractor = exports.resourceExtractor = exports.resourceFields = exports.agentListExtractor = exports.agentExtractorIfPresent = exports.agentExtractor = void 0;
+const softkave_js_utils_1 = require("softkave-js-utils");
+const agentPublicFields = (0, softkave_js_utils_1.getExtractFields)({
+    agentId: true,
+    agentType: true,
+});
+exports.agentExtractor = (0, softkave_js_utils_1.makeExtract)(agentPublicFields);
+exports.agentExtractorIfPresent = (0, softkave_js_utils_1.makeExtractIfPresent)(agentPublicFields);
+exports.agentListExtractor = (0, softkave_js_utils_1.makeListExtract)(agentPublicFields);
+exports.resourceFields = {
+    resourceId: true,
+    createdAt: true,
+    lastUpdatedAt: true,
+    deletedAt: true,
+    isDeleted: true,
+    deletedBy: exports.agentExtractorIfPresent,
+    createdBy: exports.agentExtractorIfPresent,
+    lastUpdatedBy: exports.agentExtractorIfPresent,
+};
+exports.resourceExtractor = (0, softkave_js_utils_1.makeExtract)((0, softkave_js_utils_1.getExtractFields)(exports.resourceFields));
+exports.resourceListExtractor = (0, softkave_js_utils_1.makeListExtract)((0, softkave_js_utils_1.getExtractFields)(exports.resourceFields));
+//# sourceMappingURL=extractors.js.map

package/build/src/endpoints/extractors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractors.js","sourceRoot":"","sources":["../../../src/endpoints/extractors.ts"],"names":[],"mappings":";;;AAAA,yDAM2B;AAI3B,MAAM,iBAAiB,GAAG,IAAA,oCAAgB,EAAc;IACtD,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;CAChB,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,IAAA,+BAAW,EAAC,iBAAiB,CAAC,CAAC;AAChD,QAAA,uBAAuB,GAAG,IAAA,wCAAoB,EAAC,iBAAiB,CAAC,CAAC;AAClE,QAAA,kBAAkB,GAAG,IAAA,mCAAe,EAAC,iBAAiB,CAAC,CAAC;AAExD,QAAA,cAAc,GAAsC;IAC/D,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,+BAAuB;IAClC,SAAS,EAAE,+BAAuB;IAClC,aAAa,EAAE,+BAAuB;CACvC,CAAC;AAEW,QAAA,iBAAiB,GAAG,IAAA,+BAAW,EAC1C,IAAA,oCAAgB,EAAiB,sBAAc,CAAC,CACjD,CAAC;AACW,QAAA,qBAAqB,GAAG,IAAA,mCAAe,EAClD,IAAA,oCAAgB,EAAiB,sBAAc,CAAC,CACjD,CAAC"}

package/build/src/endpoints/jobs/types.d.ts

@@ -0,0 +1,6 @@
+export interface LongRunningJobResult {
+    jobId?: string;
+}
+export interface MultipleLongRunningJobResult {
+    jobIds: string[];
+}

package/build/src/endpoints/jobs/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/build/src/endpoints/jobs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/endpoints/jobs/types.ts"],"names":[],"mappings":""}

package/build/src/endpoints/pagination.d.ts

@@ -0,0 +1,3 @@
+import { PaginationQuery } from './types';
+export declare function applyDefaultEndpointPaginationOptions(data: PaginationQuery): PaginationQuery;
+export declare function getEndpointPageFromInput(p: PaginationQuery, defaultPage?: number): number;

package/build/src/endpoints/pagination.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEndpointPageFromInput = exports.applyDefaultEndpointPaginationOptions = void 0;
+const lodash_1 = require("lodash");
+const constants_1 = require("./constants");
+const utils_1 = require("../contexts/data/utils");
+function applyDefaultEndpointPaginationOptions(data) {
+    if (data.page === undefined) {
+        data.page = constants_1.kEndpointConstants.minPage;
+    }
+    else {
+        data.page = Math.max(constants_1.kEndpointConstants.minPage, data.page);
+    }
+    if (data.pageSize === undefined) {
+        data.pageSize = constants_1.kEndpointConstants.maxPageSize;
+    }
+    else {
+        data.pageSize = Math.max(constants_1.kEndpointConstants.minPageSize, data.pageSize);
+    }
+    return data;
+}
+exports.applyDefaultEndpointPaginationOptions = applyDefaultEndpointPaginationOptions;
+function getEndpointPageFromInput(p, defaultPage = 0) {
+    return (0, lodash_1.defaultTo)((0, utils_1.getPage)(p.page), defaultPage);
+}
+exports.getEndpointPageFromInput = getEndpointPageFromInput;
+//# sourceMappingURL=pagination.js.map

package/build/src/endpoints/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../src/endpoints/pagination.ts"],"names":[],"mappings":";;;AAAA,mCAAiC;AACjC,2CAA+C;AAE/C,kDAA+C;AAE/C,SAAgB,qCAAqC,CAAC,IAAqB;IACzE,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI,CAAC,IAAI,GAAG,8BAAkB,CAAC,OAAO,CAAC;KACxC;SAAM;QACL,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,8BAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;KAC7D;IAED,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE;QAC/B,IAAI,CAAC,QAAQ,GAAG,8BAAkB,CAAC,WAAW,CAAC;KAChD;SAAM;QACL,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,8BAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;KACzE;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAdD,sFAcC;AAED,SAAgB,wBAAwB,CACtC,CAAkB,EAClB,WAAW,GAAG,CAAC;IAEf,OAAO,IAAA,kBAAS,EAAC,IAAA,eAAO,EAAC,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,CAAC,CAAC;AACjD,CAAC;AALD,4DAKC"}

package/build/src/endpoints/types.d.ts

@@ -0,0 +1,68 @@
+import { Request, RequestHandler, Response } from 'express';
+import { AnyObject, OrPromise } from 'softkave-js-utils';
+import { ValueOf } from 'type-fest';
+import { FimidaraExternalError } from '../errors/OperationError';
+import { HttpEndpointDefinitionType, MddocHttpEndpointDefinition } from '../mddoc/mddoc';
+import RequestData from './RequestData';
+export interface BaseEndpointResult {
+    errors?: FimidaraExternalError[];
+}
+export type Endpoint<TParams = any, TResult = void> = (instData: RequestData<TParams>) => Promise<TResult extends void ? void | BaseEndpointResult : TResult & BaseEndpointResult>;
+export type InferEndpointResult<TEndpoint> = TEndpoint extends Endpoint<any, infer InferedResult> ? InferedResult extends AnyObject ? InferedResult : any : any;
+export type InferEndpointParams<TEndpoint> = TEndpoint extends Endpoint<infer InferedParams, any> ? InferedParams : AnyObject;
+export declare const ServerRecommendedActionsMap: {
+    readonly LoginAgain: "loginAgain";
+    readonly Logout: "logout";
+    readonly RequestChangePassword: "requestChangePassword";
+};
+export type ServerRecommendedActions = ValueOf<typeof ServerRecommendedActionsMap>;
+export type PaginationQuery = {
+    pageSize?: number;
+    page?: number;
+};
+export interface PaginatedResult {
+    page: number;
+}
+export interface CountItemsEndpointResult {
+    count: number;
+}
+export type PaginatedEndpointCountParams<T extends PaginationQuery> = Omit<T, keyof PaginationQuery>;
+export type HttpEndpointRequestHeaders_AuthOptional = {
+    Authorization?: string;
+};
+export type HttpEndpointRequestHeaders_AuthRequired = Required<HttpEndpointRequestHeaders_AuthOptional>;
+export type HttpEndpointRequestHeaders_ContentType = {
+    'Content-Type': string;
+};
+export type HttpEndpointRequestHeaders_AuthOptional_ContentType = HttpEndpointRequestHeaders_ContentType & HttpEndpointRequestHeaders_AuthOptional;
+export type HttpEndpointRequestHeaders_AuthRequired_ContentType = Required<HttpEndpointRequestHeaders_AuthOptional_ContentType>;
+export type HttpEndpointResponseHeaders_ContentType_ContentLength = {
+    'Content-Type': string;
+    'Content-Length': string;
+};
+export type ExportedHttpEndpoint_GetDataFromReqFn = (req: Request) => OrPromise<unknown>;
+export type ExportedHttpEndpoint_HandleResponse = (res: Response, data: any) => OrPromise<void>;
+/** return `true` to defer error handling to server, allowing the function to
+ * only augment `processedErrors` instead. This can be useful for adding
+ * additional errors or fields to processed errors. */
+export type ExportedHttpEndpoint_HandleErrorFn = (res: Response, processedErrors: FimidaraExternalError[], caughtErrors: unknown) => true | void;
+export type ExportedHttpEndpoint_Cleanup = (req: Request, res: Response) => OrPromise<void>;
+export type ExportedHttpEndpointWithMddocDefinition<TEndpoint extends Endpoint = Endpoint, TRequestHeaders extends AnyObject = HttpEndpointRequestHeaders_AuthRequired_ContentType, TPathParameters extends AnyObject = AnyObject, TQuery extends AnyObject = AnyObject, TRequestBody extends AnyObject = InferEndpointParams<TEndpoint>, TResponseHeaders extends AnyObject = HttpEndpointResponseHeaders_ContentType_ContentLength, TResponseBody extends AnyObject = InferEndpointResult<TEndpoint>, TSdkParams extends AnyObject = TRequestBody> = {
+    fn: TEndpoint;
+    mddocHttpDefinition: MddocHttpEndpointDefinition<TRequestHeaders, TPathParameters, TQuery, TRequestBody, TResponseHeaders, TResponseBody, TSdkParams>;
+    getDataFromReq?: (req: Request) => OrPromise<InferEndpointParams<TEndpoint>>;
+    handleResponse?: (res: Response, data: InferEndpointResult<TEndpoint>) => OrPromise<void>;
+    handleError?: ExportedHttpEndpoint_HandleErrorFn;
+    cleanup?: ExportedHttpEndpoint_Cleanup | Array<ExportedHttpEndpoint_Cleanup>;
+    expressRouteMiddleware?: RequestHandler;
+};
+export type InferMddocHttpEndpointFromMddocEndpointDefinition<T> = T extends ExportedHttpEndpointWithMddocDefinition<any, infer T0, infer T1, infer T2, infer T3, infer T4, infer T5, infer T6> ? HttpEndpointDefinitionType<T0, T1, T2, T3, T4, T5, T6> : never;
+export declare const kEndpointResultNoteCodeMap: {
+    readonly unknown: "unknown";
+};
+export type EndpointResultNoteCode = ValueOf<typeof kEndpointResultNoteCodeMap>;
+export declare const kEndpointResultNotesToMessageMap: {};
+export interface EndpointResultNote {
+    code: EndpointResultNoteCode;
+    message: string;
+}

package/build/src/endpoints/types.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.kEndpointResultNotesToMessageMap = exports.kEndpointResultNoteCodeMap = exports.ServerRecommendedActionsMap = void 0;
+exports.ServerRecommendedActionsMap = {
+    LoginAgain: 'loginAgain',
+    Logout: 'logout',
+    RequestChangePassword: 'requestChangePassword',
+};
+exports.kEndpointResultNoteCodeMap = {
+    unknown: 'unknown',
+};
+exports.kEndpointResultNotesToMessageMap = {};
+//# sourceMappingURL=types.js.map

package/build/src/endpoints/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/endpoints/types.ts"],"names":[],"mappings":";;;AA2Ca,QAAA,2BAA2B,GAAG;IACzC,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,qBAAqB,EAAE,uBAAuB;CACtC,CAAC;AAsHE,QAAA,0BAA0B,GAAG;IACxC,OAAO,EAAE,SAAS;CACV,CAAC;AAIE,QAAA,gCAAgC,GAAG,EAAE,CAAC"}

package/build/src/endpoints/utils.d.ts

@@ -0,0 +1,23 @@
+import { Express, Request, Response } from 'express';
+import { AnyObject } from 'softkave-js-utils';
+import { Agent } from '../definitions/agent';
+import OperationError, { FimidaraExternalError } from '../errors/OperationError';
+import { Endpoint, ExportedHttpEndpointWithMddocDefinition, ExportedHttpEndpoint_Cleanup, ExportedHttpEndpoint_GetDataFromReqFn, ExportedHttpEndpoint_HandleErrorFn, ExportedHttpEndpoint_HandleResponse } from './types';
+export declare function extractExternalEndpointError(errorItem: OperationError): FimidaraExternalError;
+export declare function getPublicErrors(inputError: unknown): FimidaraExternalError[];
+export declare function prepareResponseError(error: unknown): {
+    statusCode: 500;
+    preppedErrors: FimidaraExternalError[];
+};
+export declare const wrapEndpointREST: <EndpointType extends Endpoint>(endpoint: EndpointType, handleResponse?: ExportedHttpEndpoint_HandleResponse, handleError?: ExportedHttpEndpoint_HandleErrorFn, getData?: ExportedHttpEndpoint_GetDataFromReqFn, cleanup?: ExportedHttpEndpoint_Cleanup | Array<ExportedHttpEndpoint_Cleanup>) => (req: Request, res: Response) => unknown;
+export declare function throwNotFound(): void;
+export type ResourceWithoutAssignedAgent<T> = Omit<T, 'assignedAt' | 'assignedBy'>;
+type AssignedAgent = {
+    assignedBy: Agent;
+    assignedAt: number;
+};
+export declare function withAssignedAgent<T extends AnyObject>(agent: Agent, item: T): T & AssignedAgent;
+export declare function withAssignedAgentList<T extends AnyObject>(agent: Agent, items?: T[]): Array<T & AssignedAgent>;
+export declare function endpointDecodeURIComponent(component?: unknown): string | undefined;
+export declare function registerExpressRouteFromEndpoint(endpoint: ExportedHttpEndpointWithMddocDefinition<any>, app: Express): void;
+export {};