@lilaquadrat/interfaces 1.41.0 → 1.42.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.42.0](https://github.com/lilaquadrat/interfaces/compare/v1.41.0...v1.42.0) (2026-05-21)
+
+
+### Features
+
+* **Limiter:** add LimiterTier, LimiterBreach and LimiterPluginOptions interfaces ([8dd392b](https://github.com/lilaquadrat/interfaces/commit/8dd392b10571d8d6c93c523dc3db7c961ddb5e6d))
+* **Structure,Storage,Upload:** add file asset binding and member upload metadata ([485a044](https://github.com/lilaquadrat/interfaces/commit/485a044009f281696a6098493dc327cc3d490e23))
+
 ## [1.41.0](https://github.com/lilaquadrat/interfaces/compare/v1.40.2...v1.41.0) (2026-04-16)
 
 

package/lib/cjs/AccessRule.d.ts

@@ -0,0 +1,5 @@
+export interface AccessRule {
+    state: string;
+    list: string;
+    type: 'allow' | 'deny';
+}

package/lib/cjs/LimiterBreach.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Returned by the rate limiter when a configured limit is exceeded. The
+ * caller is expected to respond 429 with the included Retry-After value
+ * (seconds until the offending window resets).
+ */
+export interface LimiterBreach {
+    /** Which bucket tripped first. */
+    interval: 'minute' | 'hour';
+    /** Configured limit for that interval. */
+    limit: number;
+    /** Observed count (post-increment) for that interval. */
+    count: number;
+    /** Seconds until the offending window resets. Suitable for Retry-After. */
+    retryAfter: number;
+}

package/lib/cjs/LimiterPluginOptions.d.ts

@@ -0,0 +1,35 @@
+import { type LimiterTier } from './LimiterTier';
+/**
+ * Per-prefix tier override. The longest matching `prefix` wins when several
+ * apply to the same request URL.
+ */
+export interface LimiterPrefixOverride {
+    prefix: string;
+    tier: LimiterTier;
+}
+/**
+ * Configuration accepted by the studio limiter Fastify plugin.
+ *
+ * Tiers are resolved from the request URL prefix:
+ *   /public/...   → tiers.public  (IP-keyed)
+ *   /members/...  → tiers.members (user-keyed, IP fallback)
+ *   everything    → tiers.user    (user-keyed, IP fallback)
+ *
+ * `namespace` is shared across APIs: same string = same counter pool.
+ */
+export interface LimiterPluginOptions {
+    /** Shared namespace across APIs. Same string = shared counters. */
+    namespace: string;
+    /** Tier per URL prefix family. */
+    tiers: {
+        public: LimiterTier;
+        members: LimiterTier;
+        user: LimiterTier;
+    };
+    /** Optional per-prefix overrides. Longest match wins. */
+    overrides?: LimiterPrefixOverride[];
+    /** Routes to skip entirely. Default: ['/health', '/']. */
+    ignoreRoutes?: string[];
+    /** Fail-open if Mongo errors. Default: true. */
+    skipOnError?: boolean;
+}

package/lib/cjs/LimiterTier.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rate-limit configuration for a single tier. Either or both fields may be
+ * set. A missing field means no limit at that interval.
+ */
+export interface LimiterTier {
+    /** Maximum requests allowed within a 60-second window. */
+    minute?: number;
+    /** Maximum requests allowed within a 60-minute window. */
+    hour?: number;
+}

package/lib/cjs/Storage.d.ts

@@ -21,8 +21,7 @@ export interface Storage {
      */
     app: string;
     /**
-     * for better classification
-     * e.g. profilepicture
+     * binds the storage document to a structure asset definition
      */
-    type?: string;
+    assetId?: string;
 }

package/lib/cjs/Structure.d.ts

@@ -10,10 +10,10 @@ export interface Structure {
     /**
      * Type of the structure
      */
-    type: 'string' | 'text' | 'number' | 'select' | 'boolean';
+    type: 'string' | 'text' | 'number' | 'select' | 'boolean' | 'file';
     model: 'listsParticipants' | 'customers';
     /**
-     * Maximum value for number type or maximum length for text type
+     * Maximum value for number, maximum length for text, or maximum number of files for file type
      */
     max?: number;
     /**
@@ -34,5 +34,11 @@ export interface Structure {
      */
     company: string;
     project: string;
+    /**
+     * file upload specifics
+     */
+    maxFileSize?: number;
+    allowedMimeTypes?: string[];
     description?: string;
+    assetId?: string;
 }

package/lib/cjs/Upload.d.ts

@@ -10,6 +10,7 @@ export interface Upload {
     list?: ObjectIdString | ObjectId;
     user?: string;
     app: string;
+    assetId?: string;
     mimetype: string;
     size?: number;
     chunks: number;
@@ -25,5 +26,12 @@ export interface Upload {
          */
         thumbnails?: boolean;
         overwrite?: boolean;
+        /**
+         * when a member uploads a file it needs to be bound to a content id and a specific module
+         * to limit the access to upload files
+         */
+        contentId?: string;
+        moduleUuid?: string;
+        structureInternalId?: ObjectId;
     };
 }

package/lib/cjs/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Access';
+export * from './AccessRule';
 export * from './Accordion';
 export * from './AccordtionElement';
 export * from './Action';
@@ -118,6 +118,9 @@ export * from './InvoiceReferences';
 export * from './InvoiceTaxBreakdown';
 export * from './InvoiceTotals';
 export * from './InvoiceWithXml';
+export * from './LimiterBreach';
+export * from './LimiterPluginOptions';
+export * from './LimiterTier';
 export * from './Link';
 export * from './LinkGroupElement';
 export * from './List';

package/lib/esm/AccessRule.d.ts

@@ -0,0 +1,5 @@
+export interface AccessRule {
+    state: string;
+    list: string;
+    type: 'allow' | 'deny';
+}

package/lib/esm/AccessRule.js

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

package/lib/esm/AccessRule.js.map

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

package/lib/esm/LimiterBreach.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Returned by the rate limiter when a configured limit is exceeded. The
+ * caller is expected to respond 429 with the included Retry-After value
+ * (seconds until the offending window resets).
+ */
+export interface LimiterBreach {
+    /** Which bucket tripped first. */
+    interval: 'minute' | 'hour';
+    /** Configured limit for that interval. */
+    limit: number;
+    /** Observed count (post-increment) for that interval. */
+    count: number;
+    /** Seconds until the offending window resets. Suitable for Retry-After. */
+    retryAfter: number;
+}

package/lib/esm/LimiterBreach.js

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

package/lib/esm/LimiterBreach.js.map

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

package/lib/esm/LimiterPluginOptions.d.ts

@@ -0,0 +1,35 @@
+import { type LimiterTier } from './LimiterTier';
+/**
+ * Per-prefix tier override. The longest matching `prefix` wins when several
+ * apply to the same request URL.
+ */
+export interface LimiterPrefixOverride {
+    prefix: string;
+    tier: LimiterTier;
+}
+/**
+ * Configuration accepted by the studio limiter Fastify plugin.
+ *
+ * Tiers are resolved from the request URL prefix:
+ *   /public/...   → tiers.public  (IP-keyed)
+ *   /members/...  → tiers.members (user-keyed, IP fallback)
+ *   everything    → tiers.user    (user-keyed, IP fallback)
+ *
+ * `namespace` is shared across APIs: same string = same counter pool.
+ */
+export interface LimiterPluginOptions {
+    /** Shared namespace across APIs. Same string = shared counters. */
+    namespace: string;
+    /** Tier per URL prefix family. */
+    tiers: {
+        public: LimiterTier;
+        members: LimiterTier;
+        user: LimiterTier;
+    };
+    /** Optional per-prefix overrides. Longest match wins. */
+    overrides?: LimiterPrefixOverride[];
+    /** Routes to skip entirely. Default: ['/health', '/']. */
+    ignoreRoutes?: string[];
+    /** Fail-open if Mongo errors. Default: true. */
+    skipOnError?: boolean;
+}

package/lib/esm/LimiterPluginOptions.js

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

package/lib/esm/LimiterPluginOptions.js.map

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

package/lib/esm/LimiterTier.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rate-limit configuration for a single tier. Either or both fields may be
+ * set. A missing field means no limit at that interval.
+ */
+export interface LimiterTier {
+    /** Maximum requests allowed within a 60-second window. */
+    minute?: number;
+    /** Maximum requests allowed within a 60-minute window. */
+    hour?: number;
+}

package/lib/esm/LimiterTier.js

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

package/lib/esm/LimiterTier.js.map

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

package/lib/esm/Storage.d.ts

@@ -21,8 +21,7 @@ export interface Storage {
      */
     app: string;
     /**
-     * for better classification
-     * e.g. profilepicture
+     * binds the storage document to a structure asset definition
      */
-    type?: string;
+    assetId?: string;
 }

package/lib/esm/Structure.d.ts

@@ -10,10 +10,10 @@ export interface Structure {
     /**
      * Type of the structure
      */
-    type: 'string' | 'text' | 'number' | 'select' | 'boolean';
+    type: 'string' | 'text' | 'number' | 'select' | 'boolean' | 'file';
     model: 'listsParticipants' | 'customers';
     /**
-     * Maximum value for number type or maximum length for text type
+     * Maximum value for number, maximum length for text, or maximum number of files for file type
      */
     max?: number;
     /**
@@ -34,5 +34,11 @@ export interface Structure {
      */
     company: string;
     project: string;
+    /**
+     * file upload specifics
+     */
+    maxFileSize?: number;
+    allowedMimeTypes?: string[];
     description?: string;
+    assetId?: string;
 }

package/lib/esm/Upload.d.ts

@@ -10,6 +10,7 @@ export interface Upload {
     list?: ObjectIdString | ObjectId;
     user?: string;
     app: string;
+    assetId?: string;
     mimetype: string;
     size?: number;
     chunks: number;
@@ -25,5 +26,12 @@ export interface Upload {
          */
         thumbnails?: boolean;
         overwrite?: boolean;
+        /**
+         * when a member uploads a file it needs to be bound to a content id and a specific module
+         * to limit the access to upload files
+         */
+        contentId?: string;
+        moduleUuid?: string;
+        structureInternalId?: ObjectId;
     };
 }

package/lib/esm/index.d.ts

@@ -1,4 +1,4 @@
-export * from './Access';
+export * from './AccessRule';
 export * from './Accordion';
 export * from './AccordtionElement';
 export * from './Action';
@@ -118,6 +118,9 @@ export * from './InvoiceReferences';
 export * from './InvoiceTaxBreakdown';
 export * from './InvoiceTotals';
 export * from './InvoiceWithXml';
+export * from './LimiterBreach';
+export * from './LimiterPluginOptions';
+export * from './LimiterTier';
 export * from './Link';
 export * from './LinkGroupElement';
 export * from './List';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lilaquadrat/interfaces",
-  "version": "1.41.0",
+  "version": "1.42.0",
   "description": "interfaces in context of lilaquadrat STUDIO",
   "author": {
     "email": "m.schuebel@lila2.de",

package/src/AccessRule.ts

@@ -0,0 +1,5 @@
+export interface AccessRule {
+    state: string
+    list: string
+     type: 'allow' | 'deny';
+}

package/src/LimiterBreach.ts

@@ -0,0 +1,15 @@
+/**
+ * Returned by the rate limiter when a configured limit is exceeded. The
+ * caller is expected to respond 429 with the included Retry-After value
+ * (seconds until the offending window resets).
+ */
+export interface LimiterBreach {
+  /** Which bucket tripped first. */
+  interval: 'minute' | 'hour';
+  /** Configured limit for that interval. */
+  limit: number;
+  /** Observed count (post-increment) for that interval. */
+  count: number;
+  /** Seconds until the offending window resets. Suitable for Retry-After. */
+  retryAfter: number;
+}

package/src/LimiterPluginOptions.ts

@@ -0,0 +1,37 @@
+import { type LimiterTier } from './LimiterTier';
+
+/**
+ * Per-prefix tier override. The longest matching `prefix` wins when several
+ * apply to the same request URL.
+ */
+export interface LimiterPrefixOverride {
+  prefix: string;
+  tier: LimiterTier;
+}
+
+/**
+ * Configuration accepted by the studio limiter Fastify plugin.
+ *
+ * Tiers are resolved from the request URL prefix:
+ *   /public/...   → tiers.public  (IP-keyed)
+ *   /members/...  → tiers.members (user-keyed, IP fallback)
+ *   everything    → tiers.user    (user-keyed, IP fallback)
+ *
+ * `namespace` is shared across APIs: same string = same counter pool.
+ */
+export interface LimiterPluginOptions {
+  /** Shared namespace across APIs. Same string = shared counters. */
+  namespace: string;
+  /** Tier per URL prefix family. */
+  tiers: {
+    public: LimiterTier;
+    members: LimiterTier;
+    user: LimiterTier;
+  };
+  /** Optional per-prefix overrides. Longest match wins. */
+  overrides?: LimiterPrefixOverride[];
+  /** Routes to skip entirely. Default: ['/health', '/']. */
+  ignoreRoutes?: string[];
+  /** Fail-open if Mongo errors. Default: true. */
+  skipOnError?: boolean;
+}

package/src/LimiterTier.ts

@@ -0,0 +1,10 @@
+/**
+ * Rate-limit configuration for a single tier. Either or both fields may be
+ * set. A missing field means no limit at that interval.
+ */
+export interface LimiterTier {
+  /** Maximum requests allowed within a 60-second window. */
+  minute?: number;
+  /** Maximum requests allowed within a 60-minute window. */
+  hour?: number;
+}

package/src/Storage.ts

@@ -29,8 +29,7 @@ export interface Storage {
     app: string
 
     /**
-     * for better classification
-     * e.g. profilepicture
+     * binds the storage document to a structure asset definition
      */
-    type?: string
+    assetId?: string
 }

package/src/Structure.ts

@@ -12,11 +12,11 @@ export interface Structure {
   /**
    * Type of the structure
    */
-  type: 'string' | 'text' | 'number' | 'select' | 'boolean'
+  type: 'string' | 'text' | 'number' | 'select' | 'boolean' | 'file'
   model: 'listsParticipants' | 'customers'
 
   /**
-   * Maximum value for number type or maximum length for text type
+   * Maximum value for number, maximum length for text, or maximum number of files for file type
    */
   max?: number
 
@@ -40,5 +40,13 @@ export interface Structure {
   company: string
   project: string
 
+
+  /**
+   * file upload specifics
+   */
+  maxFileSize?: number
+  allowedMimeTypes?: string[]
+
   description?: string
+  assetId?: string
 }

package/src/Upload.ts

@@ -11,6 +11,7 @@ export interface Upload {
     list?: ObjectIdString | ObjectId;
     user?: string;
     app: string;
+    assetId?: string;
     mimetype: string;
     size?: number;
     chunks: number;
@@ -21,7 +22,14 @@ export interface Upload {
         /**
          * create thumbnails for images
          */
-        thumbnails?: boolean,
+        thumbnails?: boolean
         overwrite?: boolean
+        /**
+         * when a member uploads a file it needs to be bound to a content id and a specific module
+         * to limit the access to upload files
+         */
+        contentId?: string
+        moduleUuid?: string
+        structureInternalId?: ObjectId
     }
 }

package/lib/cjs/Access.d.ts

@@ -1,7 +0,0 @@
-export interface Access {
-    date: Date;
-    metadata: {
-        ip?: string;
-        user?: string;
-    };
-}

package/lib/esm/Access.d.ts

@@ -1,7 +0,0 @@
-export interface Access {
-    date: Date;
-    metadata: {
-        ip?: string;
-        user?: string;
-    };
-}

package/lib/esm/Access.js

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

package/lib/esm/Access.js.map

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

package/src/Access.ts

@@ -1,7 +0,0 @@
-export interface Access {
-    date: Date
-    metadata: {
-      ip?: string,
-      user?: string
-    }
-  }