@lilaquadrat/interfaces 0.0.1 → 1.0.2

package/src/CertificateAction.ts

@@ -0,0 +1,43 @@
+import { ObjectId } from "mongodb"
+import {CertificateActionResult} from "./CertificateActionResult"
+
+export interface CertificateAction {
+  company?: string
+  project?: string
+
+  type: 'domain' | 'wildcard'
+  contentType: 'pem' | 'pfx'
+
+  domains: string[]
+
+  planned?: Date
+
+  renew: boolean,
+
+  results?: CertificateActionResult[]
+
+  certificate?: ObjectId
+
+  /** if forceFile is true, it gets saved as file in the storage account */
+  forceFile?: boolean
+
+  /** if saveInFault is true, it gets saved in the azure vault */
+  saveInVault?: boolean
+
+  /** indicated that this is the Nth retry */
+  retryCount?: number
+
+  /** indicated how often this action should be retried if failed */
+  maxRetries?: number
+
+  state:
+  | 'new'
+  | 'planned'
+  | 'inQueue'
+  | 'inProgress'
+  | 'failed'
+  | 'retry'
+  | 'success'
+  | 'canceled'
+
+}

package/src/CertificateActionResult.ts

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

package/src/ChildData.ts

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

package/src/Command.ts

@@ -0,0 +1,5 @@
+export type Command<T> = T extends 'nginx'
+  ? 'restart' | 'start' | 'stop'
+  : T extends 'docker'
+    ? 'up' | 'down' | 'rebuild' | 'stop' | 'kill' | 'restart' | 'check' | 'status'
+    : never;

package/src/Company.ts

@@ -0,0 +1,28 @@
+import { CompanyAttribute } from "./CompanyAttribute"
+
+export interface Company {
+
+  id?: string
+  name?: string
+
+  streetNumber?: string
+  zipcode?: string
+  city?: string
+  country?: string
+
+  vat?: string
+  register?: string
+
+  legalRepresentative?: string
+
+  internet?: string
+  phone?: string
+
+  description?: string
+
+  partner?: string
+  attributes?: CompanyAttribute[]
+  tags?: string[]
+  apps?: string[]
+
+}

package/src/CompanyAttribute.ts

@@ -0,0 +1 @@
+export type CompanyAttribute = 'partner' | 'admin' | 'previewInternal' | 'previewPublic';

package/src/CompanyProject.ts

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

package/src/Content.ts

@@ -0,0 +1,33 @@
+import { ObjectId } from "mongodb"
+import {ChildData} from "./ChildData"
+import {GenericData} from "./GenericData"
+import {ModuleGeneric} from "./ModuleGeneric"
+
+export interface Content {
+    id: string
+    company: string
+    project: string
+    modules: ModuleGeneric[]
+    tags?: string[]
+    description?: string
+    partial?: boolean
+    layout?: boolean
+    state: 'draft' | 'publish'
+    language?: string
+    settings: {
+      url?: string
+      useLayout?: ObjectId
+      title?: string
+      description?: string
+      noSSR?: boolean
+      noRendering?: boolean
+      filename?: string[]
+      mode?: string
+    },
+    pdf?: {
+      filename?: string
+      versioning?: boolean
+    },
+    childData?: ChildData
+    genericData?: GenericData
+}

package/src/{ContentPrepared.interface.ts → ContentWithPositions.ts}

@@ -1,7 +1,7 @@
-import AdditionalContentInformation from './AdditionalContentInformation.interface';
-import Content from './Content.interface';
+import {AdditionalContentInformation} from './AdditionalContentInformation';
+import {Content} from './Content';
 
-export default interface ContentPrepared {
+export interface ContentWithPositions {
 
   id?: Content['id']
   settings: Content['settings']

package/src/{Contract.interface.ts → Contract.ts}

@@ -1,4 +1,4 @@
-export default interface Contract {
+export interface Contract {
 
   filename: string
   size: number

package/src/{CreateResult.interface.ts → CreateResult.ts}

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

package/src/CustomerBase.ts

@@ -0,0 +1,27 @@
+export interface CustomerBase {
+
+  type?: 'person' | 'company'
+
+  id?: string
+
+  email?: string
+  /** for better sorting name will be used as lastname for persons */
+  name: string
+
+  osm_id?: number
+  street?: string
+  streetNumber?: string
+  zipcode?: string
+  city?: string
+  country?: string
+  addressAddition?: string
+
+  phone?: string
+
+  note?: string
+
+  tags?: string[]
+
+  company: string
+
+}

package/src/CustomerCompany.ts

@@ -0,0 +1,13 @@
+import { CustomerBase } from "./CustomerBase"
+
+export interface CustomerCompany extends CustomerBase {
+
+  type?: 'company'
+
+  vat?: string
+  register?: string
+
+  legalRepresentative?: string
+  internet?: string
+
+}

package/src/CustomerPerson.ts

@@ -0,0 +1,12 @@
+import { CustomerBase } from "./CustomerBase"
+
+export interface CustomerPerson extends CustomerBase {
+
+  type?: 'person'
+
+  prename: string
+
+  // birthday?: Date
+  gender?: 'm' | 'w' | 'd'
+
+}

package/src/CustomerPersonWithAddress.ts

@@ -0,0 +1,4 @@
+import { CustomerPerson } from "./CustomerPerson";
+import {Address} from "./Address";
+
+export type CustomerPersonWithAddress = CustomerPerson & Required<Address>;

package/src/CustomerPersonWithEmail.ts

@@ -0,0 +1,7 @@
+import { CustomerPerson } from "./CustomerPerson";
+
+export interface CustomerPersonWithEmail extends CustomerPerson {
+
+  email: string
+
+}

package/src/Customers.ts

@@ -0,0 +1,3 @@
+import { CustomerPerson } from "./CustomerPerson";
+import { CustomerCompany } from "./CustomerCompany";
+export type Customers = CustomerCompany | CustomerPerson;

package/src/CustomersModelActions.ts

@@ -0,0 +1,2 @@
+export type CustomersModelActions = 'createPersonMinimal' | 'createPersonExternal'
+  | 'createPersonExternalWithAddress' | 'createCompanyMinimal' | 'changePersonMinimal' | 'changeCompanyMinimal'

package/src/{DataObject.interface.ts → DataObject.ts}

@@ -1,4 +1,4 @@
-export default interface DataObject<T> {
+export interface DataObject<T> {
   count?: number;
   all?: number;
 

package/src/DatabaseQuery.ts

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

package/src/{DatabaseQueryOptions.interface.ts → DatabaseQueryOptions.ts}

@@ -1,4 +1,4 @@
-export default interface DatabaseQueryOptions {
+export interface DatabaseQueryOptions {
   /**
      * include immutable history entries in the data
      *

package/src/{DatabaseQuerySites.interface.ts → DatabaseQuerySites.ts}

@@ -1,4 +1,4 @@
-export default interface DatabaseQuerySites {
+export interface DatabaseQuerySites {
 
   first: number;
   current: number;

package/src/{DesignModule.interface.ts → DesignModule.ts}

@@ -1,6 +1,6 @@
-import AvailableVariant, { EditorMode } from "./AvailableVariant.interface"
+import { AvailableVariant, EditorMode } from "./AvailableVariant"
 
-export default interface DesignModule {
+export 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

package/src/Domain.ts

@@ -0,0 +1,37 @@
+import { ObjectId } from "mongodb"
+import { Certificate } from "./Certificate"
+
+export interface Domain {
+
+  domain: string
+
+  // not required for system domains
+  company?: string
+  project?: string
+
+  /**
+   * this is the main domain, all other will be redirected to this
+   */
+  isMain?: boolean
+  /**
+   * this domain is the ``https://COMPANY-PROJECT.BASEHOSTINGDOMAIN`` that is generated on hosting creation
+   */
+  isDefault?: boolean
+
+  active?: boolean
+
+  /**
+   * the domain is through dns validated
+   */
+  validated?: boolean
+
+  /**
+   * the secret that needs to be added to dns
+   */
+  secret?: ObjectId;
+
+  attributes?: string[]
+
+  certificate?: ObjectId | Partial<Certificate>
+
+}

package/src/{DomainConf.interface.ts → DomainConf.ts}

@@ -1,6 +1,6 @@
-import { Domain } from '../../studio-package/interfaces';
+import { Domain } from "./Domain"
 
-export default interface DomainConf {
+export interface DomainConf {
 
   domains: Domain[]
 

package/src/DomainsList.ts

@@ -0,0 +1,14 @@
+import { Certificate } from "./Certificate"
+import { Domain } from "./Domain"
+
+export interface DomainsList extends Domain {
+
+  certificate: Partial<Certificate>
+
+  certificateNeeded: boolean
+
+  hosting?: {
+    active?: boolean
+  }
+
+}

package/src/EditorActiveModule.ts

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

package/src/EditorBase.ts

@@ -0,0 +1,7 @@
+export interface EditorBase {
+  company: string
+  project: string
+  type: 'app' | 'server'
+  date: Date
+  custom?: boolean
+}

package/src/{EditorLegacy.interface.ts → EditorLegacy.ts}

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

package/src/{GenericData.interface.ts → GenericData.ts}

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

package/src/GenericDataWithContent.ts

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

package/src/History.ts

@@ -0,0 +1,22 @@
+import { ObjectId } from "mongodb"
+import { HistoryReason } from "./HistoryReason"
+
+export interface History {
+
+  history: {
+    version: number
+    parent: ObjectId
+    reason: HistoryReason
+    user: string
+    app: string
+    date: Date
+    source: string
+    update?: Date
+    branchVersion?: number
+    copySource?: ObjectId
+    model: string
+  }
+
+  [key: string]: any;
+
+}

package/src/HistoryReason.ts

@@ -0,0 +1 @@
+export type HistoryReason = 'create' | 'change' | 'recreate' | 'delete' | 'copy';

package/src/HistoryWithType.ts

@@ -0,0 +1,20 @@
+import { ObjectId } from "mongodb";
+import { HistoryReason } from "./HistoryReason";
+
+export type HistoryWithType<T> = T & {
+
+    history: {
+      version: number
+      parent: ObjectId
+      reason: HistoryReason
+      user: string
+      app: string
+      date: Date
+      source: string
+      update?: Date
+      branchVersion?: number
+      copySource?: ObjectId
+      model: string
+    }
+  
+  };

package/src/HostindCommand.ts

@@ -0,0 +1,16 @@
+import { Command } from "./Command";
+
+export interface HostingCommand {
+  target: 'nginx' | 'docker';
+  command: Command<HostingCommand['target']>;
+  date: Date;
+  state: 'new' | 'inProgress' | 'success' | 'error';
+  data: { [key: string]: any };
+  batchId?: string;
+  company?: string;
+  project?: string;
+  after?: {
+    target: 'nginx' | 'docker';
+    command: Command<HostingCommand['target']>;
+  };
+}

package/src/Hosting.ts

@@ -0,0 +1,8 @@
+export interface Hosting {
+  project: string;
+  company: string;
+
+  active?: boolean;
+
+  port?: number;
+}

package/src/HostingPorts.ts

@@ -0,0 +1,4 @@
+export interface HostingPorts {
+  http: number
+  https: number
+}

package/src/HostingSettings.ts

@@ -0,0 +1,5 @@
+export interface HostingSettings {
+  id: string,
+  baseDomain: string,
+  ipAdresses: string[]
+}

package/src/HostingWithSettings.ts

@@ -0,0 +1,7 @@
+import { Hosting } from "./Hosting"
+
+export interface HostingWithSettings extends Hosting {
+  settings: {
+    ip: string
+  }
+}

package/src/HttpStatusCodes.ts

@@ -0,0 +1,13 @@
+export type HttpStatusCode = 
+    // 1xx Informational
+    100 | 101 | 102 | 103 |
+    // 2xx Success
+    200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 |
+    // 3xx Redirection
+    300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 |
+    // 4xx Client Error
+    400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 |
+    410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 |
+    422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 |
+    // 5xx Server Error
+    500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;

package/src/Id.ts

@@ -0,0 +1,4 @@
+export interface Id {
+  id: string
+  data: unknown
+}

package/src/IdentifiersEntity.ts

@@ -0,0 +1,4 @@
+export interface IdentifiersEntity {
+  type: string;
+  value: string;
+}

package/src/List.ts

@@ -0,0 +1,34 @@
+import { ObjectId } from "mongodb";
+import {Agreement} from "./Agreement";
+import { ListCategory } from "./ListCategory";
+
+export interface List {
+    _id?: ObjectId;
+  
+    company: string
+    project: string
+  
+    name: string
+    description?: string
+    mode: 'contact' | 'content' | 'reservation'
+  
+    start?: Date
+    end?: Date
+  
+    payment: 'optional' | 'required' | 'free'
+  
+    participants?: {
+      max?: number
+      confirmed?: number
+      reserved?: number
+      available?: number
+      unique?: boolean
+      addressRequired?: boolean
+    }
+  
+    state: 'open' | 'closed' | 'waiting'
+  
+    agreements: Agreement[]
+  
+    categories: ListCategory[]
+  }

package/src/ListCategory.ts

@@ -0,0 +1,12 @@
+import Price from "./Price";
+
+export interface ListCategory {
+
+  id: string;
+  name: string
+  description?: string
+  amount?: number
+  disabled?: boolean
+  price?: Price
+
+}

package/src/{ListCustomQueries.interface.ts → ListCustomQueries.ts}

@@ -1,6 +1,6 @@
 import { Filter } from "mongodb"
 
-export default interface ListCustomQuery<M> {
+export interface ListCustomQueries<M> {
 
     countQuery: Filter<M>
     aggregation: Object[]

package/src/{ListOfModels.interface.ts → ListOfModels.ts}

@@ -1,4 +1,4 @@
-export default interface ListOfModel<T> {
+export interface ListOfModels<T> {
   data?: T[]
   all?: number
   count?: number

package/src/ListParticipantWithUser.ts

@@ -0,0 +1,12 @@
+import { ObjectId } from "mongodb";
+import { ListParticipants } from "./ListParticipants";
+
+export type ListParticipantWithUser = ListParticipants
+& {
+  user: {
+    name: string,
+    email: string,
+    id: string,
+    _id: ObjectId
+  }
+};

package/src/ListParticipants.ts

@@ -0,0 +1,38 @@
+import { ObjectId } from "mongodb"
+import {AgreementResponse} from "./AgreementResponse"
+
+export interface ListParticipants {
+  _id?: ObjectId
+
+  list: ObjectId
+
+  company: string
+  project: string
+
+  user: ObjectId
+
+  /**
+   * message from the participant
+   */
+  message?: string
+  /**
+   * internal note
+   */
+  note?: string
+
+  category?: string
+
+  explanation?: string
+
+  /*
+  enlisted = customer has joined the list, but the owner did not confirm it
+  confirmed = customer has joined the list and the owner did confirm it or the list does not required confirmation
+  reserved = It implies that the customer has successfully secured a place on the list and is awaiting further instructions or actions.
+  waiting = customer has joined the list and waits on action from the owner
+  blocked = customer is not part of the list and cant join it
+  finalized = the list entry has fulfilled his purpose and no further action is required
+  */
+  state: 'unchecked' | 'notuseful' | 'confirmed' | 'enlisted' | 'reserved' | 'waiting' | 'blocked' | 'finalized'
+  agreements: AgreementResponse[]
+
+}

package/src/{ListParticipantsDetails.interface.ts → ListParticipantsDetails.ts}

@@ -1,4 +1,4 @@
-export default interface ListPartiticpantsDetails {
+export interface ListPartiticpantsDetails {
 
     used: number
     categories: { id: string, used: number }[]