@lilaquadrat/interfaces 1.31.0 → 1.33.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [1.33.0](https://github.com/lilaquadrat/interfaces/compare/v1.32.0...v1.33.0) (2025-12-23)
+
+
+### Features
+
+* **databasequeryoptions:** added search ([99d6a62](https://github.com/lilaquadrat/interfaces/commit/99d6a62b0be4b291d7cd69f85665bd2fb273907a))
+* **mongodb:** installed version 7 ([92d072e](https://github.com/lilaquadrat/interfaces/commit/92d072e83cfec43970029e19b52f3ad51c312db8))
+
+
+### Bug Fixes
+
+* **storage:** company and filename are required ([c2da646](https://github.com/lilaquadrat/interfaces/commit/c2da6460ef5a2e82b034056647b7cd3b78b6ec42))
+
+## [1.32.0](https://github.com/lilaquadrat/interfaces/compare/v1.31.0...v1.32.0) (2025-12-12)
+
+
+### Features
+
+* **Storage, Upload:** enhance interfaces with customer and list properties; add StorageFilePaths interface ([b466639](https://github.com/lilaquadrat/interfaces/commit/b466639dcbad3ae03e9a33a540c80958c6f4491f))
+
 ## [1.31.0](https://github.com/lilaquadrat/interfaces/compare/v1.30.0...v1.31.0) (2025-11-01)
 
 

package/lib/cjs/AvailableStorageTypes.d.ts

@@ -1 +1 @@
-export type AvailableStorageTypes = 'mock' | 'azureBlob' | 'azureStorage' | 'filesystem';
+export type AvailableStorageTypes = 'mock' | 'azureBlob' | 'azureStorage' | 'filesystem' | 'minio';

package/lib/cjs/DatabaseQueryOptions.d.ts

@@ -28,4 +28,5 @@ export interface DatabaseQueryOptions {
        */
     keepSearch?: boolean;
     keepSort?: boolean;
+    search?: string[];
 }

package/lib/cjs/Media.d.ts

@@ -1,6 +1,6 @@
 import { ObjectId } from "mongodb";
 import { Content } from "./Content";
-import { MediaInfo } from "./MediaInfo";
+import { MediaMetadata } from "./MediaMetadata";
 import { MediaViewInfo } from "./MediaViewInfo";
 import { VersionInfo } from "./VersionInfo";
 export interface Media {
@@ -18,10 +18,12 @@ export interface Media {
     video?: boolean;
     folder?: boolean;
     mimetype?: string;
-    info?: MediaInfo;
+    path?: string;
+    info?: MediaMetadata;
     view?: MediaViewInfo;
     download?: string;
     basePath?: string;
+    copyright?: string;
     baseContent?: {
         id: ObjectId;
         version: number;

package/lib/cjs/MediaMetadata.d.ts

@@ -0,0 +1,17 @@
+export interface MediaMetadata {
+    /**
+     * e.g. 'untouched' or 'thumbnail_250' or 'optimized'
+     */
+    type?: string;
+    width?: number;
+    height?: number;
+    ratio?: number;
+    orientation?: 'landscape' | 'portrait' | 'square' | 'unknown';
+    /**
+     * in bytes
+     */
+    size?: number;
+    mimetype?: string;
+    copyright?: string;
+    tags?: string[];
+}

package/lib/cjs/PathMapping.d.ts

@@ -0,0 +1,7 @@
+export interface PathMapping {
+    filename: string;
+    mimetype: string;
+    path: string;
+    company: string;
+    project: string;
+}

package/lib/cjs/ShareClientOptions.d.ts

@@ -6,4 +6,16 @@ export interface ShareClientOptions {
     baseFolder?: string;
     accountName?: string;
     sharedKeyCredentials?: StorageSharedKeyCredential;
+    /**
+     * s3/minio accessKey
+     */
+    accessKey?: string;
+    /**
+   * s3/minio secretKey
+   */
+    secretKey?: string;
+    /**
+     * s3/minio endpoint
+     */
+    endpoint?: string;
 }

package/lib/cjs/Storage.d.ts

@@ -0,0 +1,28 @@
+import { ObjectId } from "mongodb";
+import { MediaMetadata } from "./MediaMetadata";
+export interface Storage {
+    company: string;
+    project?: string;
+    /**
+     * this document can be bound to a specific customer
+     */
+    customer?: ObjectId;
+    /**
+     * this document can be bound to a specific list and customer
+     */
+    list?: ObjectId;
+    filename: string;
+    prefix?: string;
+    path?: string;
+    metadata?: MediaMetadata;
+    parent?: ObjectId;
+    /**
+     * app functions here as a bucket
+     */
+    app?: string;
+    /**
+     * for better classification
+     * e.g. profilepicture
+     */
+    type?: string;
+}

package/lib/cjs/StorageFilePaths.d.ts

@@ -0,0 +1,5 @@
+export interface StorageFilePaths {
+    dir: string;
+    file: string;
+    relativePath: string;
+}

package/lib/cjs/StorageWithVersions.d.ts

@@ -0,0 +1,4 @@
+import { Storage } from "./Storage";
+export type StorageWithVersions = Storage & {
+    versions?: Storage[];
+};

package/lib/cjs/Stored.d.ts

@@ -0,0 +1,7 @@
+import { ObjectId } from "mongodb";
+/**
+ * the passed data comes from mongodb and has a _id
+ */
+export type Stored<T> = T & {
+    _id: ObjectId;
+};

package/lib/cjs/Upload.d.ts

@@ -0,0 +1,29 @@
+import { ObjectId } from 'mongodb';
+import { ObjectIdString } from './ObjectIdString';
+export interface Upload {
+    _id?: ObjectId;
+    filename?: string;
+    prefix?: string;
+    company?: string;
+    project?: string;
+    customer?: ObjectIdString | ObjectId;
+    list?: ObjectIdString | ObjectId;
+    user?: string;
+    app?: string;
+    mimetype?: string;
+    size?: number;
+    chunks: number;
+    paths?: {
+        path: string;
+        index: number;
+    }[];
+    updated?: Date;
+    state?: 'uploading' | 'waiting' | 'processing' | 'finished' | 'error';
+    options?: {
+        /**
+         * create thumbnails for images
+         */
+        thumbnails?: boolean;
+        overwrite?: boolean;
+    };
+}

package/lib/cjs/index.d.ts

@@ -129,7 +129,7 @@ export * from './MePermissionsProject';
 export * from './Media';
 export * from './MediaApp';
 export * from './MediaContentFiles';
-export * from './MediaInfo';
+export * from './MediaMetadata';
 export * from './MediaStats';
 export * from './MediaViewInfo';
 export * from './MenuCategoryElement';
@@ -149,6 +149,7 @@ export * from './ObjectIdString';
 export * from './Options';
 export * from './PartialModule';
 export * from './Partner';
+export * from './PathMapping';
 export * from './Payment';
 export * from './PaymentProvider';
 export * from './PaymentProviderShopify';
@@ -192,6 +193,10 @@ export * from './ShareClientOptions';
 export * from './ShopifyProjectSettings';
 export * from './ShoppingCartModule';
 export * from './SkipLimitSort';
+export * from './Storage';
+export * from './StorageFilePaths';
+export * from './StorageWithVersions';
+export * from './Stored';
 export * from './StoryModule';
 export * from './Structure';
 export * from './StudioIframeMessage';
@@ -203,6 +208,7 @@ export * from './TrackerInput';
 export * from './TrackerStatistics';
 export * from './TrainingMdule';
 export * from './Universal';
+export * from './Upload';
 export * from './UserApp';
 export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';

package/lib/esm/AvailableStorageTypes.d.ts

@@ -1 +1 @@
-export type AvailableStorageTypes = 'mock' | 'azureBlob' | 'azureStorage' | 'filesystem';
+export type AvailableStorageTypes = 'mock' | 'azureBlob' | 'azureStorage' | 'filesystem' | 'minio';

package/lib/esm/DatabaseQueryOptions.d.ts

@@ -28,4 +28,5 @@ export interface DatabaseQueryOptions {
        */
     keepSearch?: boolean;
     keepSort?: boolean;
+    search?: string[];
 }

package/lib/esm/Media.d.ts

@@ -1,6 +1,6 @@
 import { ObjectId } from "mongodb";
 import { Content } from "./Content";
-import { MediaInfo } from "./MediaInfo";
+import { MediaMetadata } from "./MediaMetadata";
 import { MediaViewInfo } from "./MediaViewInfo";
 import { VersionInfo } from "./VersionInfo";
 export interface Media {
@@ -18,10 +18,12 @@ export interface Media {
     video?: boolean;
     folder?: boolean;
     mimetype?: string;
-    info?: MediaInfo;
+    path?: string;
+    info?: MediaMetadata;
     view?: MediaViewInfo;
     download?: string;
     basePath?: string;
+    copyright?: string;
     baseContent?: {
         id: ObjectId;
         version: number;

package/lib/esm/MediaMetadata.d.ts

@@ -0,0 +1,17 @@
+export interface MediaMetadata {
+    /**
+     * e.g. 'untouched' or 'thumbnail_250' or 'optimized'
+     */
+    type?: string;
+    width?: number;
+    height?: number;
+    ratio?: number;
+    orientation?: 'landscape' | 'portrait' | 'square' | 'unknown';
+    /**
+     * in bytes
+     */
+    size?: number;
+    mimetype?: string;
+    copyright?: string;
+    tags?: string[];
+}

package/lib/esm/MediaMetadata.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=MediaMetadata.js.map

package/lib/esm/MediaMetadata.js.map

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

package/lib/esm/PathMapping.d.ts

@@ -0,0 +1,7 @@
+export interface PathMapping {
+    filename: string;
+    mimetype: string;
+    path: string;
+    company: string;
+    project: string;
+}

package/lib/esm/PathMapping.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PathMapping.js.map

package/lib/esm/PathMapping.js.map

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

package/lib/esm/ShareClientOptions.d.ts

@@ -6,4 +6,16 @@ export interface ShareClientOptions {
     baseFolder?: string;
     accountName?: string;
     sharedKeyCredentials?: StorageSharedKeyCredential;
+    /**
+     * s3/minio accessKey
+     */
+    accessKey?: string;
+    /**
+   * s3/minio secretKey
+   */
+    secretKey?: string;
+    /**
+     * s3/minio endpoint
+     */
+    endpoint?: string;
 }

package/lib/esm/Storage.d.ts

@@ -0,0 +1,28 @@
+import { ObjectId } from "mongodb";
+import { MediaMetadata } from "./MediaMetadata";
+export interface Storage {
+    company: string;
+    project?: string;
+    /**
+     * this document can be bound to a specific customer
+     */
+    customer?: ObjectId;
+    /**
+     * this document can be bound to a specific list and customer
+     */
+    list?: ObjectId;
+    filename: string;
+    prefix?: string;
+    path?: string;
+    metadata?: MediaMetadata;
+    parent?: ObjectId;
+    /**
+     * app functions here as a bucket
+     */
+    app?: string;
+    /**
+     * for better classification
+     * e.g. profilepicture
+     */
+    type?: string;
+}

package/lib/esm/Storage.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Storage.js.map

package/lib/esm/Storage.js.map

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

package/lib/esm/StorageFilePaths.d.ts

@@ -0,0 +1,5 @@
+export interface StorageFilePaths {
+    dir: string;
+    file: string;
+    relativePath: string;
+}

package/lib/esm/StorageFilePaths.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=StorageFilePaths.js.map

package/lib/esm/StorageFilePaths.js.map

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

package/lib/esm/StorageWithVersions.d.ts

@@ -0,0 +1,4 @@
+import { Storage } from "./Storage";
+export type StorageWithVersions = Storage & {
+    versions?: Storage[];
+};

package/lib/esm/StorageWithVersions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=StorageWithVersions.js.map

package/lib/esm/StorageWithVersions.js.map

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

package/lib/esm/Stored.d.ts

@@ -0,0 +1,7 @@
+import { ObjectId } from "mongodb";
+/**
+ * the passed data comes from mongodb and has a _id
+ */
+export type Stored<T> = T & {
+    _id: ObjectId;
+};

package/lib/esm/Stored.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Stored.js.map

package/lib/esm/Stored.js.map

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

package/lib/esm/Upload.d.ts

@@ -0,0 +1,29 @@
+import { ObjectId } from 'mongodb';
+import { ObjectIdString } from './ObjectIdString';
+export interface Upload {
+    _id?: ObjectId;
+    filename?: string;
+    prefix?: string;
+    company?: string;
+    project?: string;
+    customer?: ObjectIdString | ObjectId;
+    list?: ObjectIdString | ObjectId;
+    user?: string;
+    app?: string;
+    mimetype?: string;
+    size?: number;
+    chunks: number;
+    paths?: {
+        path: string;
+        index: number;
+    }[];
+    updated?: Date;
+    state?: 'uploading' | 'waiting' | 'processing' | 'finished' | 'error';
+    options?: {
+        /**
+         * create thumbnails for images
+         */
+        thumbnails?: boolean;
+        overwrite?: boolean;
+    };
+}

package/lib/esm/Upload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Upload.js.map

package/lib/esm/Upload.js.map

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

package/lib/esm/index.d.ts

@@ -129,7 +129,7 @@ export * from './MePermissionsProject';
 export * from './Media';
 export * from './MediaApp';
 export * from './MediaContentFiles';
-export * from './MediaInfo';
+export * from './MediaMetadata';
 export * from './MediaStats';
 export * from './MediaViewInfo';
 export * from './MenuCategoryElement';
@@ -149,6 +149,7 @@ export * from './ObjectIdString';
 export * from './Options';
 export * from './PartialModule';
 export * from './Partner';
+export * from './PathMapping';
 export * from './Payment';
 export * from './PaymentProvider';
 export * from './PaymentProviderShopify';
@@ -192,6 +193,10 @@ export * from './ShareClientOptions';
 export * from './ShopifyProjectSettings';
 export * from './ShoppingCartModule';
 export * from './SkipLimitSort';
+export * from './Storage';
+export * from './StorageFilePaths';
+export * from './StorageWithVersions';
+export * from './Stored';
 export * from './StoryModule';
 export * from './Structure';
 export * from './StudioIframeMessage';
@@ -203,6 +208,7 @@ export * from './TrackerInput';
 export * from './TrackerStatistics';
 export * from './TrainingMdule';
 export * from './Universal';
+export * from './Upload';
 export * from './UserApp';
 export * from './UserAppOptionsRequired';
 export * from './UserAppWithOptions';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lilaquadrat/interfaces",
-  "version": "1.31.0",
+  "version": "1.33.0",
   "description": "interfaces in context of lilaquadrat STUDIO",
   "author": {
     "email": "m.schuebel@lila2.de",
@@ -32,7 +32,7 @@
     "@types/node": "^20.11.9",
     "ajv": "^8.12.0",
     "cz-conventional-changelog": "^3.3.0",
-    "mongodb": "^6.12.0",
+    "mongodb": "^7.0.0",
     "standard-version": "^9.5.0"
   },
   "config": {

package/src/AvailableStorageTypes.ts

@@ -1 +1 @@
-export type AvailableStorageTypes = 'mock'|'azureBlob'|'azureStorage'|'filesystem';
+export type AvailableStorageTypes = 'mock' | 'azureBlob' | 'azureStorage' | 'filesystem' | 'minio';

package/src/DatabaseQueryOptions.ts

@@ -28,4 +28,5 @@ export interface DatabaseQueryOptions {
      */
   keepSearch?: boolean;
   keepSort?: boolean;
+  search?: string[];
 }

package/src/Media.ts

@@ -1,6 +1,6 @@
 import { ObjectId } from "mongodb";
 import {Content} from "./Content";
-import { MediaInfo } from "./MediaInfo";
+import { MediaMetadata } from "./MediaMetadata";
 import { MediaViewInfo } from "./MediaViewInfo";
 import { VersionInfo } from "./VersionInfo";
 
@@ -22,12 +22,15 @@ export interface Media {
   video?: boolean;
   folder?: boolean;
   mimetype?: string;
+  path?: string
 
-  info?: MediaInfo;
+  info?: MediaMetadata;
   view?: MediaViewInfo;
   download?: string;
   basePath?: string;
 
+  copyright?: string;
+
   baseContent?: {
     id: ObjectId,
     version: number

package/src/MediaMetadata.ts

@@ -0,0 +1,17 @@
+export interface MediaMetadata {
+  /**
+   * e.g. 'untouched' or 'thumbnail_250' or 'optimized'
+   */
+  type?: string
+  width?: number
+  height?: number
+  ratio?: number
+  orientation?: 'landscape' | 'portrait' | 'square' | 'unknown'
+  /**
+   * in bytes
+   */
+  size?: number
+  mimetype?: string
+  copyright?: string
+  tags?: string[]
+}

package/src/PathMapping.ts

@@ -0,0 +1,7 @@
+export interface PathMapping {
+    filename: string
+    mimetype: string
+    path: string
+    company: string
+    project: string
+}

package/src/ShareClientOptions.ts

@@ -7,4 +7,16 @@ export interface ShareClientOptions {
   baseFolder?: string
   accountName?: string
   sharedKeyCredentials?: StorageSharedKeyCredential
+  /**
+   * s3/minio accessKey
+   */
+  accessKey?: string
+  /**
+ * s3/minio secretKey
+ */
+  secretKey?: string
+  /**
+   * s3/minio endpoint
+   */
+  endpoint?: string
 }

package/src/Storage.ts

@@ -0,0 +1,36 @@
+import { ObjectId } from "mongodb";
+import { MediaMetadata } from "./MediaMetadata";
+
+export interface Storage {
+    company: string
+    project?: string
+
+    /**
+     * this document can be bound to a specific customer
+     */
+    customer?: ObjectId
+    /**
+     * this document can be bound to a specific list and customer
+     */
+    list?: ObjectId
+
+    filename: string
+    prefix?: string
+    
+    path?: string
+
+    metadata?: MediaMetadata
+
+    parent?: ObjectId
+
+    /**
+     * app functions here as a bucket
+     */
+    app?: string
+
+    /**
+     * for better classification
+     * e.g. profilepicture
+     */
+    type?: string
+}

package/src/StorageFilePaths.ts

@@ -0,0 +1,5 @@
+export interface StorageFilePaths {
+    dir: string
+    file: string
+    relativePath: string
+}

package/src/StorageWithVersions.ts

@@ -0,0 +1,5 @@
+import { Storage } from "./Storage";
+
+export type StorageWithVersions = Storage & {
+    versions?: Storage[]
+}

package/src/Stored.ts

@@ -0,0 +1,11 @@
+import { ObjectId } from "mongodb"
+
+/**
+ * the passed data comes from mongodb and has a _id
+ */
+export type Stored<T> = T & {
+
+  _id: ObjectId
+
+}
+

package/src/Upload.ts

@@ -0,0 +1,27 @@
+import { ObjectId } from 'mongodb';
+import { ObjectIdString } from './ObjectIdString';
+
+export interface Upload {
+    _id?: ObjectId;
+    filename?: string;
+    prefix?: string;
+    company?: string;
+    project?: string;
+    customer?: ObjectIdString | ObjectId;
+    list?: ObjectIdString | ObjectId;
+    user?: string;
+    app?: string;
+    mimetype?: string;
+    size?: number;
+    chunks: number;
+    paths?: { path: string, index: number }[];
+    updated?: Date;
+    state?: 'uploading' | 'waiting' | 'processing' | 'finished' | 'error';
+    options?: {
+        /**
+         * create thumbnails for images
+         */
+        thumbnails?: boolean,
+        overwrite?: boolean
+    }
+}

package/lib/cjs/MediaInfo.d.ts

@@ -1,6 +0,0 @@
-export interface MediaInfo {
-    width?: number;
-    height?: number;
-    ratio?: number;
-    size?: number;
-}

package/lib/esm/MediaInfo.d.ts

@@ -1,6 +0,0 @@
-export interface MediaInfo {
-    width?: number;
-    height?: number;
-    ratio?: number;
-    size?: number;
-}

package/lib/esm/MediaInfo.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=MediaInfo.js.map

package/lib/esm/MediaInfo.js.map

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

package/src/MediaInfo.ts

@@ -1,6 +0,0 @@
-export interface MediaInfo {
-  width?: number;
-  height?: number;
-  ratio?: number;
-  size?: number;
-}