@tstdl/base 0.92.147 → 0.92.149

package/api/client/client.d.ts

@@ -1,4 +1,5 @@
 import { HttpClient, type HttpClientOptions } from '../../http/client/index.js';
+import { bustCacheToken } from '../../http/index.js';
 import { type Resolvable } from '../../injector/interfaces.js';
 import type { Type } from '../../types/index.js';
 import { type ApiClientImplementation, type ApiDefinition, type ApiEndpointDefinition } from '../types.js';
@@ -13,6 +14,7 @@ export type ClientOptions = {
 };
 export type ApiClientHttpRequestContext = {
     endpoint: ApiEndpointDefinition;
+    [bustCacheToken]?: boolean;
 };
 export declare const httpClientSymbol: unique symbol;
 export declare const apiDefinitionSymbol: unique symbol;

package/api/client/client.js

@@ -1,5 +1,5 @@
 import { HttpClient, HttpClientRequest } from '../../http/client/index.js';
-import { normalizeSingleHttpValue } from '../../http/types.js';
+import { bustCacheToken, normalizeSingleHttpValue } from '../../http/index.js';
 import { inject } from '../../injector/inject.js';
 import { Injector } from '../../injector/injector.js';
 import { resolveArgumentType } from '../../injector/interfaces.js';
@@ -74,6 +74,9 @@ export function compileClient(definition, options = defaultOptions) {
                     }
                     return getServerSentEvents(this[httpClientSymbol].options.baseUrl, resource, endpoint, parameters);
                 }
+                if (context.endpoint.data?.[bustCacheToken] == true) {
+                    context[bustCacheToken] = true;
+                }
                 const request = new HttpClientRequest({
                     method,
                     url: resource,

package/api/utils.d.ts

@@ -5,5 +5,6 @@ type GetApiEndpointUrlData = {
     defaultPrefix: string | undefined | null;
     explicitVersion?: number | null;
 };
+export declare const defaultAccessControlAllowHeaders = "Content-Type, Authorization";
 export declare function getFullApiEndpointResource({ api, endpoint, defaultPrefix, explicitVersion }: GetApiEndpointUrlData): string;
 export {};

package/api/utils.js

@@ -2,6 +2,7 @@ import { toArray } from '../utils/array/array.js';
 import { compareByValueDescending } from '../utils/comparison.js';
 import { sort } from '../utils/iterable-helpers/sort.js';
 import { isDefined, isNull } from '../utils/type-guards.js';
+export const defaultAccessControlAllowHeaders = 'Content-Type, Authorization';
 export function getFullApiEndpointResource({ api, endpoint, defaultPrefix, explicitVersion }) {
     const versionArray = toArray(isDefined(explicitVersion) ? explicitVersion : endpoint.version);
     const version = sort(versionArray, compareByValueDescending)[0];

package/document-management/api/document-management.api.d.ts

@@ -1,3 +1,4 @@
+import { bustCacheToken } from '../../http/tokens.js';
 import { ServerSentEvents } from '../../sse/server-sent-events.js';
 import { Document, DocumentCategory, DocumentRequest, DocumentRequestsTemplate, DocumentRequestTemplate, DocumentType } from '../models/index.js';
 import { DocumentCategoryView, DocumentManagementData, DocumentRequestsTemplateData } from '../service-models/index.js';
@@ -22,6 +23,12 @@ export declare const documentManagementApiDefinition: {
             }>;
             result: typeof ServerSentEvents;
             credentials: true;
+            data: {
+                [bustCacheToken]: boolean;
+            };
+            cors: {
+                accessControlAllowHeaders: string;
+            };
         };
         loadDocumentRequestsTemplateData: {
             resource: string;
@@ -413,6 +420,12 @@ declare const _DocumentManagementApi: import("../../api/client/index.js").ApiCli
             }>;
             result: typeof ServerSentEvents;
             credentials: true;
+            data: {
+                [bustCacheToken]: boolean;
+            };
+            cors: {
+                accessControlAllowHeaders: string;
+            };
         };
         loadDocumentRequestsTemplateData: {
             resource: string;

package/document-management/api/document-management.api.js

@@ -6,6 +6,8 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 };
 import { compileClient } from '../../api/client/index.js';
 import { defineApi } from '../../api/index.js';
+import { defaultAccessControlAllowHeaders } from '../../api/utils.js';
+import { bustCacheToken } from '../../http/tokens.js';
 import { ReplaceClass } from '../../injector/decorators.js';
 import { array, boolean, literal, number, object, optional, string } from '../../schema/index.js';
 import { ServerSentEvents } from '../../sse/server-sent-events.js';
@@ -28,6 +30,12 @@ export const documentManagementApiDefinition = defineApi({
             parameters: loadDataParametersSchema,
             result: ServerSentEvents,
             credentials: true,
+            data: {
+                [bustCacheToken]: true,
+            },
+            cors: {
+                accessControlAllowHeaders: `${defaultAccessControlAllowHeaders}, Cache-Control`,
+            },
         },
         loadDocumentRequestsTemplateData: {
             resource: 'views/document-requests-template-data',

package/document-management/server/services/document-management.service.d.ts

@@ -3,6 +3,20 @@ import { Transactional } from '../../../orm/server/index.js';
 import type { Record } from '../../../types/index.js';
 import { DocumentCategory, DocumentType, type DocumentProperty, type DocumentPropertyDataType } from '../../models/index.js';
 import type { DocumentManagementData, DocumentRequestsTemplateData } from '../../service-models/index.js';
+export type CategoryLabels<CategoryKey extends string> = Record<CategoryKey, string>;
+export type CategoryParents<CategoryKey extends string> = Record<CategoryKey, CategoryKey | null>;
+export type TypeLabels<TypeKey extends string> = Record<TypeKey, string>;
+export type TypeCategories<TypeKey extends string, CategoryKey extends string> = Record<TypeKey, CategoryKey>;
+export type PropertyConfigurations<DocumentPropertyKey extends string> = Record<DocumentPropertyKey, [DocumentPropertyDataType, label: string]>;
+export type TypeProperties<TypeKey extends string, DocumentPropertyKey extends string> = Record<TypeKey, DocumentPropertyKey[]>;
+export type CategoriesAndTypesInitializationData<CategoryKey extends string, TypeKey extends string, DocumentPropertyKey extends string> = {
+    categoryLabels: CategoryLabels<CategoryKey>;
+    categoryParents: CategoryParents<NoInfer<CategoryKey>>;
+    typeLabels: TypeLabels<TypeKey>;
+    typeCategories: TypeCategories<NoInfer<TypeKey>, NoInfer<CategoryKey>>;
+    propertyConfigurations: PropertyConfigurations<DocumentPropertyKey>;
+    typeProperties: TypeProperties<NoInfer<TypeKey>, NoInfer<DocumentPropertyKey>>;
+};
 export declare class DocumentManagementService extends Transactional {
     #private;
     /**
@@ -14,7 +28,7 @@ export declare class DocumentManagementService extends Transactional {
     loadDataStream(tenantId: string, collectionIds: string[], cancellationSignal: CancellationSignal): AsyncIterableIterator<DocumentManagementData>;
     loadData(tenantId: string, collectionIds: string[]): Promise<DocumentManagementData>;
     loadDocumentRequestsTemplateData(tenantId: string | null): Promise<DocumentRequestsTemplateData>;
-    initializeCategoriesAndTypes<CategoryKey extends string, TypeKey extends string, DocumentPropertyKey extends string>(tenantId: string | null, categoryLabels: Record<CategoryKey, string>, categoryParents: Record<CategoryKey, CategoryKey | null>, typeLabels: Record<TypeKey, string>, typeCategories: Record<TypeKey, CategoryKey>, propertyKeys: Record<DocumentPropertyKey, [DocumentPropertyDataType, string]>, typeProperties: Record<TypeKey, DocumentPropertyKey[]>): Promise<{
+    initializeCategoriesAndTypes<CategoryKey extends string, TypeKey extends string, DocumentPropertyKey extends string>(tenantId: string | null, data: CategoriesAndTypesInitializationData<CategoryKey, TypeKey, DocumentPropertyKey>): Promise<{
         categories: Record<CategoryKey, DocumentCategory>;
         types: Record<TypeKey, DocumentType>;
         properties: Record<DocumentPropertyKey, DocumentProperty>;

package/document-management/server/services/document-management.service.js

@@ -177,10 +177,10 @@ let DocumentManagementService = DocumentManagementService_1 = class DocumentMana
             return { templates };
         });
     }
-    async initializeCategoriesAndTypes(tenantId, categoryLabels, categoryParents, typeLabels, typeCategories, propertyKeys, typeProperties) {
-        const categoryEntries = objectEntries(categoryLabels);
-        const typeEntries = objectEntries(typeLabels);
-        const propertyEntries = objectEntries(propertyKeys);
+    async initializeCategoriesAndTypes(tenantId, data) {
+        const categoryEntries = objectEntries(data.categoryLabels);
+        const typeEntries = objectEntries(data.typeLabels);
+        const propertyEntries = objectEntries(data.propertyConfigurations);
         const { categoryMap, typeMap, propertyMap } = await this.transaction(async (tx) => {
             const { categories: dbCategories, types: dbTypes } = await this.#documentCategoryTypeService.withTransaction(tx).loadCategoriesAndTypes(tenantId);
             const dbProperties = await this.#documentPropertyService.withTransaction(tx).repository.loadManyByQuery({ tenantId });
@@ -192,7 +192,7 @@ let DocumentManagementService = DocumentManagementService_1 = class DocumentMana
             const enumKeyPropertyMap = groupToSingleMap(properties, (property) => property.metadata.attributes[enumTypeKey]);
             for (const [enumKey, label] of categoryEntries) {
                 const category = enumKeyCategoryMap.get(enumKey);
-                const parentKey = assertDefinedPass(categoryParents[enumKey], `Parent category not defined for ${enumKey}`);
+                const parentKey = assertDefinedPass(data.categoryParents[enumKey], `Parent category not defined for ${enumKey}`);
                 const parentCategory = isNull(parentKey) ? null : assertDefinedPass(enumKeyCategoryMap.get(parentKey));
                 const parentCategoryId = parentCategory?.id ?? null;
                 if (isUndefined(category)) {
@@ -208,7 +208,7 @@ let DocumentManagementService = DocumentManagementService_1 = class DocumentMana
             }
             for (const [enumKey, label] of typeEntries) {
                 const type = enumKeyTypeMap.get(enumKey);
-                const enumCategory = typeCategories[enumKey];
+                const enumCategory = data.typeCategories[enumKey];
                 const category = assertDefinedPass(enumKeyCategoryMap.get(enumCategory));
                 if (isUndefined(type)) {
                     const type = await this.#documentCategoryTypeService.withTransaction(tx).createType({ tenantId, label, categoryId: category.id, enumKey });
@@ -234,7 +234,7 @@ let DocumentManagementService = DocumentManagementService_1 = class DocumentMana
                     this.#logger.info(`Updated property ${updatedProperty.label} of type ${updatedProperty.dataType}`);
                 }
             }
-            for (const [typeKey, propertyKeys] of objectEntries(typeProperties)) {
+            for (const [typeKey, propertyKeys] of objectEntries(data.typeProperties)) {
                 const type = assertDefinedPass(enumKeyTypeMap.get(typeKey), `Type ${typeKey} not found.`);
                 const newEntities = propertyKeys.map((propertyKey) => ({
                     tenantId,

package/examples/document-management/main.js

@@ -134,7 +134,14 @@ async function bootstrap() {
 async function main() {
     const tenantId = '00000000-0000-0000-0000-000000000000';
     const [documentManagementService, documentCollectionService] = await injectManyAsync(DocumentManagementService, DocumentCollectionService, DocumentCategoryTypeService, DocumentRequestService);
-    const { categories, types } = await documentManagementService.initializeCategoriesAndTypes(tenantId, TstdlDocumentCategoryLabels, TstdlCategoryParents, TstdlDocumentTypeLabels, TstdlDocumentTypeCategories, TstdlDocumentPropertyConfiguration, TstdlDocumentTypeProperties);
+    const { categories, types } = await documentManagementService.initializeCategoriesAndTypes(tenantId, {
+        categoryLabels: TstdlDocumentCategoryLabels,
+        categoryParents: TstdlCategoryParents,
+        typeLabels: TstdlDocumentTypeLabels,
+        typeCategories: TstdlDocumentTypeCategories,
+        propertyConfigurations: TstdlDocumentPropertyConfiguration,
+        typeProperties: TstdlDocumentTypeProperties,
+    });
     const collectionCount = await documentCollectionService.repository.count();
     if (collectionCount == 0) {
         await documentCollectionService.createCollection(tenantId, null, { metadata: { attributes: { name: 'Objekt ABC' } } });

package/http/client/http-client-request.js

@@ -138,7 +138,7 @@ export class HttpClientRequest {
             body,
             timeout: this.timeout,
             throwOnNon200: this.throwOnNon200,
-            context: this.context
+            context: this.context,
         };
     }
 }

package/http/index.d.ts

@@ -13,5 +13,6 @@ export * from './http-url-parameters.js';
 export * from './http-value-map.js';
 export * from './http.error.js';
 export * from './server/index.js';
+export * from './tokens.js';
 export * from './types.js';
 export * from './utils.js';

package/http/index.js

@@ -13,5 +13,6 @@ export * from './http-url-parameters.js';
 export * from './http-value-map.js';
 export * from './http.error.js';
 export * from './server/index.js';
+export * from './tokens.js';
 export * from './types.js';
 export * from './utils.js';

package/http/tokens.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This can be used in the request context to indicate that the request should not be cached.
+ * HttpClientAdapters should check for this token and bypass any caching mechanisms if it is present.
+ */
+export declare const bustCacheToken: unique symbol;

package/http/tokens.js

@@ -0,0 +1,5 @@
+/**
+ * This can be used in the request context to indicate that the request should not be cached.
+ * HttpClientAdapters should check for this token and bypass any caching mechanisms if it is present.
+ */
+export const bustCacheToken = Symbol('bustCacheToken');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tstdl/base",
-  "version": "0.92.147",
+  "version": "0.92.149",
   "author": "Patrick Hein",
   "publishConfig": {
     "access": "public"