@lilaquadrat/interfaces 0.0.1

package/dist/Location.interface.d.ts

@@ -0,0 +1,25 @@
+export default interface Location {
+    place_id: string;
+    licence: string;
+    osm_type: string;
+    osm_id: string;
+    boundingbox: string[];
+    lat: string;
+    lon: string;
+    display_name: string;
+    class: string;
+    type: string;
+    importance: number;
+    address: {
+        name: string;
+        house_number: string;
+        road: string;
+        neighbourhood: string;
+        suburb: string;
+        city: string;
+        state: string;
+        postcode: string;
+        country: string;
+        country_code: string;
+    };
+}

package/dist/Modelv2.interface.d.ts

@@ -0,0 +1,3 @@
+export default interface Modelv2 {
+    SchemaType: 'change' | 'create' | string;
+}

package/dist/ModuleGeneric.interface.d.ts

@@ -0,0 +1,16 @@
+import ChildData from './ChildData.interface';
+import ModuleIndexOptions from './ModuleIndexOptions.interface';
+import ModulePDFOptions from './ModulePDFOptions.interface';
+export default interface ModuleGeneric {
+    [key: string]: any;
+    id?: string;
+    type: string;
+    uuid?: string;
+    variant?: string[];
+    position?: string;
+    layout?: 'first' | 'last' | '';
+    source?: string;
+    childData?: ChildData;
+    index?: ModuleIndexOptions;
+    pdf?: ModulePDFOptions;
+}

package/dist/ModuleIndexOptions.interface.d.ts

@@ -0,0 +1,6 @@
+export default interface ModuleIndexOptions {
+    anchor?: string;
+    title?: string;
+    type?: string;
+    uuid?: string;
+}

package/dist/ModulePDFOptions.interface.d.ts

@@ -0,0 +1,4 @@
+export default interface ModulePDFOptions {
+    newSiteAfter?: boolean;
+    newSiteBefore?: boolean;
+}

package/dist/ModuleSettings.interface.d.ts

@@ -0,0 +1,7 @@
+import AvailableVariant, { EditorMode } from "./AvailableVariant.interface";
+export default interface ModuleSettings {
+    variants: AvailableVariant[];
+    editor: {
+        modes: EditorMode[];
+    };
+}

package/dist/Options.interface.d.ts

@@ -0,0 +1,4 @@
+export default interface Options {
+    company?: string;
+    project?: string;
+}

package/dist/Partner.interface.d.ts

@@ -0,0 +1,14 @@
+import BasicDataInterface from './BasicData.interface';
+import Contract from './Contract.interface';
+export default interface Partner extends BasicDataInterface {
+    id?: string;
+    state?: string;
+    contract?: {
+        file?: string | Contract;
+        user?: string;
+        date?: Date;
+        path?: string;
+        confirmed?: boolean;
+    };
+    contacts?: string[];
+}

package/dist/Permissions.interface.d.ts

@@ -0,0 +1,16 @@
+interface ProjectPermissions {
+    _id: string;
+    company: string;
+    project: string;
+    name: string;
+    id: string;
+    scope: string[];
+}
+interface CompanyWithProjectsPermissions<T = ProjectPermissions> {
+    _id?: string;
+    name?: string;
+    projects?: T[];
+    scope: string[];
+}
+type Permissions = CompanyWithProjectsPermissions[];
+export { Permissions, ProjectPermissions, CompanyWithProjectsPermissions };

package/dist/Price.interface.d.ts

@@ -0,0 +1,5 @@
+export default interface Price {
+    amount: number;
+    currency: string;
+    tax: number;
+}

package/dist/PublishResult.interface.d.ts

@@ -0,0 +1,9 @@
+import { ObjectId } from 'mongodb';
+export default interface PublishResult {
+    referenceId: ObjectId;
+    state: 'error' | 'success';
+    error?: string;
+    message?: string;
+    id?: string;
+    name?: string;
+}

package/dist/PublishResultStatistics.interface.d.ts

@@ -0,0 +1,6 @@
+export default interface PublishResultStatistics {
+    affected: number;
+    error: number;
+    success: number;
+    successPercent: number;
+}

package/dist/RenderContext.interface.d.ts

@@ -0,0 +1,15 @@
+import Content from './Content.interface';
+export default interface RenderContext {
+    url?: string;
+    data?: Content;
+    layout?: Content;
+    title?: string;
+    description?: string;
+    settings?: Record<string, unknown>;
+    translation?: Record<string, string>;
+    tags?: string[];
+    app?: string;
+    css?: string;
+    cdn?: string;
+    renderTarget?: 'pdf' | 'web';
+}

package/dist/Scope.interface.d.ts

@@ -0,0 +1,10 @@
+export interface Scope extends Array<SingleScope> {
+}
+export interface SingleScope extends String {
+}
+export interface ScopeObject {
+    [key: string]: Scope;
+}
+export interface ScopeObjectWithAdmin {
+    [key: string]: Scope;
+}

package/dist/ShareClientOptions.interface.d.ts

@@ -0,0 +1,6 @@
+export default interface ShareClientOptions {
+    connectionString: string;
+    container?: string;
+    shareName?: string;
+    baseFolder?: string;
+}

package/dist/SkipLimitSort.interface.d.ts

@@ -0,0 +1,8 @@
+import { SortDirection } from "mongodb";
+export default interface SkipLimitSort {
+    skip: number;
+    limit: number;
+    sort: {
+        [key: string]: SortDirection;
+    };
+}

package/dist/StudioIframeMessage.interface.d.ts

@@ -0,0 +1,6 @@
+export default interface StudioIframeMessage<T> {
+    data: {
+        type: 'studio-content' | 'studio-editor-settings' | 'studio-settings' | 'studio-active' | 'studio-cookie-reset';
+        data: T;
+    };
+}

package/dist/TrackerStatistics.interface.d.ts

@@ -0,0 +1,23 @@
+import { Tracker } from '../../studio-package/src/models/tracker.model';
+export type TrackerCategories = 'call' | 'worktime' | 'all';
+export interface TrackerData {
+    count: number;
+    time: number;
+}
+export default interface TrackerStatistics {
+    count: number;
+    all: TrackerData;
+    categories: {
+        all?: Partial<Record<TrackerCategories, TrackerData>>;
+        byMonth?: Partial<Record<string, Partial<Record<TrackerCategories, TrackerData>>>>;
+        byDay?: Partial<Record<string, Partial<Record<TrackerCategories, TrackerData>>>>;
+    };
+    start: Date;
+    end: Date;
+}
+export interface TrackerStatisticsDay {
+    data: Tracker[];
+    count: number;
+    statistics: Partial<Record<TrackerCategories, TrackerData>>;
+    date: Date;
+}

package/dist/Universal.interface.d.ts

@@ -0,0 +1,8 @@
+import { ObjectId } from 'mongodb';
+export default interface UniversalInterface {
+    [key: string]: unknown;
+    id?: string | number;
+    _id?: ObjectId;
+    referenceId?: ObjectId;
+    company: string;
+}

package/dist/UserApp.interface.d.ts

@@ -0,0 +1,4 @@
+export default interface UserApp {
+    user?: string;
+    app?: string;
+}

package/dist/UserAppOptionsRequired.interface.d.ts

@@ -0,0 +1,6 @@
+export default interface UserAppOptionsRequired {
+    user: string;
+    app: string;
+    company: string;
+    project: string;
+}

package/dist/UserAppWithOptions.interface.d.ts

@@ -0,0 +1,4 @@
+import Options from './Options.interface';
+import UserApp from './UserApp.interface';
+type UserAppWithOptions = Options & UserApp;
+export default UserAppWithOptions;

package/dist/Wildcardcertificates.interface.d.ts

@@ -0,0 +1,13 @@
+export default interface WildcartCertificate {
+    identifiers?: IdentifiersEntity[];
+    cert: string;
+    chain: string;
+    valid: {
+        from: Date;
+        to: Date;
+    };
+}
+export interface IdentifiersEntity {
+    type: string;
+    value: string;
+}

package/helper.js

@@ -0,0 +1,31 @@
+const fs = require('fs');
+const path = require('path');
+
+const distDir = './dist';
+const outputPath = path.join(distDir, 'index.d.ts');
+
+// Read all files in the dist directory
+fs.readdir(distDir, (err, files) => {
+  if (err) {
+    console.error('Error reading dist directory:', err);
+    return;
+  }
+
+  // Filter out only .d.ts files and exclude index.d.ts
+  const exports = files
+    .filter(file => file.endsWith('.d.ts') && file !== 'index.d.ts')
+    .map(file => {
+      // Assuming the structure is flat and files can be exported directly
+      const moduleName = file.replace('.d.ts', '');
+      return `export * from './${moduleName}';`;
+    });
+
+  // Write the index.d.ts file
+  fs.writeFile(outputPath, exports.join('\n'), (err) => {
+    if (err) {
+      console.error('Error writing index.d.ts:', err);
+    } else {
+      console.log('index.d.ts created successfully.');
+    }
+  });
+});

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@lilaquadrat/interfaces",
+  "version": "0.0.1",
+  "description": "interfaces in context of lilaquadrat STUDIO",
+  "author": "mschuebel <m.schuebel@lila2.de>",
+  "license": "MIT",
+  "dependencies": {
+    "typescript": "^5.3.3"
+  },
+  "scripts": {
+    "build": "tsc && node create-index.js"
+  },
+  "main": "dist/index.d.ts",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/Action.interface.ts

@@ -0,0 +1 @@
+export type Action = 'read' | 'remove' | 'create' | 'edit' | 'list' | 'history' | 'settings';

package/src/AdditionalContentInformation.interface.ts

@@ -0,0 +1,5 @@
+import ModuleIndexOptions from './ModuleIndexOptions.interface';
+
+export default interface AdditionalContentInformation {
+  index?: ModuleIndexOptions[]
+}

package/src/Address.interface.ts

@@ -0,0 +1,9 @@
+export default interface Address {
+    osm_id?: number;
+    street?: string;
+    streetNumber?: string;
+    zipcode?: string;
+    city?: string;
+    country?: string;
+    addressAddition?: string;
+}

package/src/Agreement.interface.ts

@@ -0,0 +1,6 @@
+export default interface Agreement {
+    required: boolean
+    text: string
+    contentId: string
+    predefined?: boolean
+}

package/src/AgreementResponse.interface.ts

@@ -0,0 +1,4 @@
+export default interface AgreementResponse {
+    id: string
+    version: number
+}

package/src/ApiResponses.interface.ts

@@ -0,0 +1,15 @@
+import HttpStatusCode from './HttpStatusCode.enum';
+
+export default interface ApiResponses<T = void> {
+
+  post: {
+    data: T,
+    status: HttpStatusCode.OK | HttpStatusCode.NO_CONTENT
+  }
+
+  put: {
+    data: T,
+    status: HttpStatusCode.OK | HttpStatusCode.NO_CONTENT
+  }
+
+}

package/src/App.interface.ts

@@ -0,0 +1,23 @@
+import BasicDataInterface from './BasicData.interface';
+
+export default interface App extends BasicDataInterface {
+
+  id: string
+  name: string;
+
+  universal: boolean
+  description?: string
+
+  /** list of models that are used in this app. needed for model based permissions */
+  models: string[]
+
+  icon: string
+
+  companyAvailable: boolean
+  projectAvailable: boolean
+
+  attributes?: 'previewInternal'|'previewPublic'|'paid'[]
+
+  available?: 'unavailable' | 'internal' | 'preview' | 'public';
+
+}

package/src/AppFilter.interface.ts

@@ -0,0 +1 @@
+export default interface AppFilter extends Array<'active' | 'admin' | 'previewPublic' | 'previewInternal' | 'paid'> { }

package/src/AppPermissions.ts

@@ -0,0 +1,9 @@
+import { Scope } from './Scope.interface';
+
+export default interface AppPermissions {
+  app: string;
+  company: string;
+  project: string;
+
+  scope: Scope;
+}

package/src/AvailableStorageTypes.interface.ts

@@ -0,0 +1,2 @@
+type AvailableStorageTypes = 'mock'|'azureBlob'|'azureStorage'|'filesystem';
+export default AvailableStorageTypes;

package/src/AvailableVariant.interface.ts

@@ -0,0 +1,10 @@
+export default interface AvailableVariant {
+    key: string
+    name: string
+    description: string
+    group?: string
+}
+type EditorMode = Omit<AvailableVariant, 'group'>;
+export {
+    EditorMode
+};

package/src/BaseFilterOptions.interface.ts

@@ -0,0 +1,7 @@
+export default interface BaseFilterOptions {
+  partial?: boolean
+  layout?: boolean
+  available?: boolean
+  tags?: string[]
+  search?: string
+}

package/src/BasicData.interface.ts

@@ -0,0 +1,19 @@
+import { ObjectId } from 'mongodb';
+
+export default interface BasicDataInterface {
+
+  id?: string | number
+  company?: string
+  project?: string
+  app?: string
+  model?: string
+  _id?: ObjectId
+  history?: {
+    version?: number
+    source: string
+    created?: Date
+    updated?: Date
+    additional?: any
+  };
+
+}

package/src/CallResponse.interface.ts

@@ -0,0 +1,6 @@
+import HttpStatusCode from './HttpStatusCode.enum';
+
+export default interface CallResponse<T> {
+  status: HttpStatusCode;
+  r: T;
+}

package/src/CertificateActionResult.interface.ts

@@ -0,0 +1,4 @@
+export default interface CertificateActionResult {
+  error?: string
+  message?: string
+}

package/src/ChildData.interface.ts

@@ -0,0 +1,8 @@
+import Content from './Content.interface';
+
+export default interface ChildData {
+  data: {
+    [key: string]: Content
+  }
+  index: string[]
+}

package/src/CompanyProject.interface.ts

@@ -0,0 +1,3 @@
+import Options from './Options.interface';
+
+export default interface CompanyProject extends Required<Options> {}

package/src/Content.interface.ts

@@ -0,0 +1,3 @@
+import { Editor } from '../../studio-package/src/models/editor.model';
+
+export default interface Content extends Editor { }

package/src/ContentPrepared.interface.ts

@@ -0,0 +1,13 @@
+import AdditionalContentInformation from './AdditionalContentInformation.interface';
+import Content from './Content.interface';
+
+export default interface ContentPrepared {
+
+  id?: Content['id']
+  settings: Content['settings']
+  top: Content['modules']
+  content: Content['modules']
+  bottom: Content['modules']
+  additional: AdditionalContentInformation
+
+}

package/src/Contract.interface.ts

@@ -0,0 +1,9 @@
+export default interface Contract {
+
+  filename: string
+  size: number
+  fromCompany: string
+  mimetype: string
+  path?: string
+
+}

package/src/CreateResult.interface.ts

@@ -0,0 +1,8 @@
+import { InferIdType } from 'mongodb';
+
+export default interface CreateResult<T> {
+
+  _id: InferIdType<T>
+  id?: string | number
+
+}

package/src/DataObject.interface.ts

@@ -0,0 +1,13 @@
+export default interface DataObject<T> {
+  count?: number;
+  all?: number;
+
+  sites?: {
+    first: number,
+    last: number,
+    current: number,
+    range: [number, number]
+  }
+
+  data?: T;
+}

package/src/DatabaseQuery.interface.ts

@@ -0,0 +1,3 @@
+export default interface DatabaseQuery {
+  [key: string]: any
+}

package/src/DatabaseQueryOptions.interface.ts

@@ -0,0 +1,31 @@
+export default interface DatabaseQueryOptions {
+  /**
+     * include immutable history entries in the data
+     *
+     * @type {boolean}
+     * @memberof DatabaseQueryOptions
+     */
+  includeHistory?: boolean;
+  /**
+     * query for history entries, doesnt delete immutable_parent
+     *
+     * @type {boolean}
+     * @memberof DatabaseQueryOptions
+     */
+  isHistory?: boolean;
+  /**
+     * tags is a predefined attribute
+     * is this is true, the query builder will leave them alone
+     *
+     * @type {boolean}
+     * @memberof DatabaseQueryOptions
+     */
+  keepTags?: boolean;
+  /**
+     *
+     * @type {boolean}
+     * @memberof DatabaseQueryOptions
+     */
+  keepSearch?: boolean;
+  keepSort?: boolean;
+}

package/src/DatabaseQuerySites.interface.ts

@@ -0,0 +1,13 @@
+export default interface DatabaseQuerySites {
+
+  first: number;
+  current: number;
+  last: number;
+
+  /**
+     * the range of documents you got
+     * example: site 1, limit 10, 10 or more documents in the database
+     * [1, 10]
+     */
+  range: [number, number];
+}

package/src/DesignModule.interface.ts

@@ -0,0 +1,15 @@
+import AvailableVariant, { EditorMode } from "./AvailableVariant.interface"
+
+export default interface DesignModule {
+  name: string,
+  /**
+  * helps complex modules like contact.module for show different states like the form and the sucess content after submitting the form
+  *
+  * only available in editor mode 
+  */
+  editor: {
+    modes: EditorMode[]
+  },
+  variants: AvailableVariant[],
+  component: () => void
+}

package/src/DomainConf.interface.ts

@@ -0,0 +1,20 @@
+import { Domain } from '../../studio-package/interfaces';
+
+export default interface DomainConf {
+
+  domains: Domain[]
+
+  port?: number
+
+  ports?: {
+    http?: number,
+    https?: number,
+  }
+
+  company: string
+  project: string
+
+  defaultDomain?: string
+
+  certificate?: string
+}

package/src/EditorActiveModule.interface.ts

@@ -0,0 +1,4 @@
+export default interface EditorActiveModule {
+  uuid?: string
+  position?: string
+}

package/src/EditorLegacy.interface.ts

@@ -0,0 +1,5 @@
+export default interface EditorLegacy {
+  __v?: string;
+  immutable_history?: string;
+  immutable_user?: string;
+}

package/src/GenericData.interface.ts

@@ -0,0 +1,14 @@
+import Content from "./Content.interface"
+
+type CompatibleGenericDataType = 'editor' | 'lists' | 'customers' | 'media';
+
+type GenericData = {
+    [key in CompatibleGenericDataType]: string[]
+} & {
+    data: Content[]
+}
+
+export default GenericData;
+export {
+    CompatibleGenericDataType
+}

package/src/GenericDataWithContent.interface.ts

@@ -0,0 +1,8 @@
+import Content from "./Content.interface"
+import { CompatibleGenericDataType } from "./GenericData.interface";
+
+type GenericDataWithContent = {
+    [key in CompatibleGenericDataType]: Record<string, Content>
+}
+
+export default GenericDataWithContent;