@lilaquadrat/interfaces 0.0.1 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+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.0.2](https://github.com/lilaquadrat/interfaces/compare/v1.0.1...v1.0.2) (2024-01-29)
+
+### 1.0.1 (2024-01-29)

package/README.md

@@ -0,0 +1,14 @@
+[![lilaquadrat STUDIO](https://cdn3.lilaquadrat.de/lilaquadrat/homepage/untouched_bannerlinkedin2.png)](https://lilaquadrat.de)
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/lilaquadrat/interfaces?style=flat-square)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/lilaquadrat/interfaces?style=flat-square)
+
+# lilaquadrat STUDIO
+
+lilaquadrat STUDIO is a modular and extensible SaaS Enterprise CMS.
+
+[https://lilaquadrat.de](https://lilaquadrat.de)
+
+## STUDIO Interfaces
+
+This repository has Typescript interfaces that are used accros the different parts of STUDIO

package/helper.js

@@ -1,9 +1,19 @@
 const fs = require('fs');
 const path = require('path');
+const args = process.argv;
 
-const distDir = './dist';
+const target = args[2] || 'cjs';
+
+const distDir = `./lib/${target}`;
 const outputPath = path.join(distDir, 'index.d.ts');
 
+if(target === 'cjs') {
+
+  fs.writeFileSync(`${distDir}/index.js`, '');
+  console.log(`index.js for ${target} created successfully.`);
+
+} 
+
 // Read all files in the dist directory
 fs.readdir(distDir, (err, files) => {
   if (err) {
@@ -25,7 +35,9 @@ fs.readdir(distDir, (err, files) => {
     if (err) {
       console.error('Error writing index.d.ts:', err);
     } else {
-      console.log('index.d.ts created successfully.');
+      console.log(`index.d.ts for ${target} created successfully.`);
     }
   });
 });
+
+

package/lib/cjs/Access.d.ts

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

package/lib/cjs/AdditionalContentInformation.d.ts

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

package/{dist/Address.interface.d.ts → lib/cjs/Address.d.ts}

@@ -1,4 +1,4 @@
-export default interface Address {
+export interface Address {
     osm_id?: number;
     street?: string;
     streetNumber?: string;

package/{dist/Agreement.interface.d.ts → lib/cjs/Agreement.d.ts}

@@ -1,4 +1,4 @@
-export default interface Agreement {
+export interface Agreement {
     required: boolean;
     text: string;
     contentId: string;

package/lib/cjs/AgreementResponse.d.ts

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

package/lib/cjs/ApiResponses.d.ts

@@ -0,0 +1,10 @@
+export interface ApiResponses<T = void> {
+    post: {
+        data: T;
+        status: 200 | 204;
+    };
+    put: {
+        data: T;
+        status: 200 | 204;
+    };
+}

package/{dist/App.interface.d.ts → lib/cjs/App.d.ts}

@@ -1,5 +1,4 @@
-import BasicDataInterface from './BasicData.interface';
-export default interface App extends BasicDataInterface {
+export interface App {
     id: string;
     name: string;
     universal: boolean;

package/lib/cjs/AppFilter.d.ts

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

package/lib/cjs/AppPermissions.d.ts

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

package/lib/cjs/AvailableStorageTypes.d.ts

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

package/{dist/AvailableVariant.interface.d.ts → lib/cjs/AvailableVariant.d.ts}

@@ -1,4 +1,4 @@
-export default interface AvailableVariant {
+export interface AvailableVariant {
     key: string;
     name: string;
     description: string;

package/{dist/BaseFilterOptions.interface.d.ts → lib/cjs/BaseFilterOptions.d.ts}

@@ -1,4 +1,4 @@
-export default interface BaseFilterOptions {
+export interface BaseFilterOptions {
     partial?: boolean;
     layout?: boolean;
     available?: boolean;

package/{dist/BasicData.interface.d.ts → lib/cjs/BasicData.d.ts}

@@ -1,5 +1,5 @@
 import { ObjectId } from 'mongodb';
-export default interface BasicDataInterface {
+export type BasicData<T> = T & {
     id?: string | number;
     company?: string;
     project?: string;
@@ -13,4 +13,4 @@ export default interface BasicDataInterface {
         updated?: Date;
         additional?: any;
     };
-}
+};

package/lib/cjs/BasicDataDatabase.d.ts

@@ -0,0 +1,16 @@
+import { ObjectId } from 'mongodb';
+export type BasicDataDatabase<T> = T & {
+    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/lib/cjs/CallResponse.d.ts

@@ -0,0 +1,5 @@
+import { HttpStatusCode } from "./HttpStatusCodes";
+export interface CallResponse<T> {
+    status: HttpStatusCode;
+    r: T;
+}

package/lib/cjs/Certificate.d.ts

@@ -0,0 +1,13 @@
+export interface Certificate {
+    company?: string;
+    project?: string;
+    filename?: string;
+    valid: {
+        from: Date;
+        to: Date;
+        isValid?: boolean;
+    };
+    type: 'domain' | 'wildcard';
+    contentType: 'pem' | 'pfx';
+    domains: string[];
+}

package/lib/cjs/CertificateAction.d.ts

@@ -0,0 +1,22 @@
+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/lib/cjs/CertificateActionResult.d.ts

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

package/lib/cjs/ChildData.d.ts

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

package/lib/cjs/Command.d.ts

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

package/lib/cjs/Company.d.ts

@@ -0,0 +1,19 @@
+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/lib/cjs/CompanyAttribute.d.ts

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

package/lib/cjs/CompanyProject.d.ts

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

package/lib/cjs/Content.d.ts

@@ -0,0 +1,32 @@
+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/{dist/ContentPrepared.interface.d.ts → lib/cjs/ContentWithPositions.d.ts}

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

package/{dist/Contract.interface.d.ts → lib/cjs/Contract.d.ts}

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

package/{dist/CreateResult.interface.d.ts → lib/cjs/CreateResult.d.ts}

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

package/lib/cjs/CustomerBase.d.ts

@@ -0,0 +1,18 @@
+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/lib/cjs/CustomerCompany.d.ts

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

package/lib/cjs/CustomerPerson.d.ts

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

package/lib/cjs/CustomerPersonWithAddress.d.ts

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

package/lib/cjs/CustomerPersonWithEmail.d.ts

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

package/lib/cjs/Customers.d.ts

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

package/lib/cjs/CustomersModelActions.d.ts

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

package/{dist/DataObject.interface.d.ts → lib/cjs/DataObject.d.ts}

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

package/lib/cjs/DatabaseQuery.d.ts

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

package/{dist/DatabaseQueryOptions.interface.d.ts → lib/cjs/DatabaseQueryOptions.d.ts}

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

package/{dist/DatabaseQuerySites.interface.d.ts → lib/cjs/DatabaseQuerySites.d.ts}

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

package/{dist/DesignModule.interface.d.ts → lib/cjs/DesignModule.d.ts}

@@ -1,5 +1,5 @@
-import AvailableVariant, { EditorMode } from "./AvailableVariant.interface";
-export default interface DesignModule {
+import { AvailableVariant, EditorMode } from "./AvailableVariant";
+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/lib/cjs/Domain.d.ts

@@ -0,0 +1,26 @@
+import { ObjectId } from "mongodb";
+import { Certificate } from "./Certificate";
+export interface Domain {
+    domain: string;
+    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/{dist/DomainConf.interface.d.ts → lib/cjs/DomainConf.d.ts}

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

package/lib/cjs/DomainsList.d.ts

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

package/lib/cjs/EditorActiveModule.d.ts

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

package/lib/cjs/EditorBase.d.ts

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

package/{dist/EditorLegacy.interface.d.ts → lib/cjs/EditorLegacy.d.ts}

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

package/lib/cjs/GenericData.d.ts

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

package/lib/cjs/GenericDataWithContent.d.ts

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

package/lib/cjs/History.d.ts

@@ -0,0 +1,18 @@
+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/lib/cjs/HistoryWithType.d.ts

@@ -0,0 +1,17 @@
+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/lib/cjs/HostindCommand.d.ts

@@ -0,0 +1,17 @@
+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/lib/cjs/Hosting.d.ts

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

package/lib/cjs/HostingPorts.d.ts

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

package/lib/cjs/HostingSettings.d.ts

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

package/lib/cjs/HostingWithSettings.d.ts

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

package/lib/cjs/HttpStatusCodes.d.ts

@@ -0,0 +1 @@
+export type HttpStatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 306 | 307 | 308 | 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 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;

package/lib/cjs/Id.d.ts

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

package/lib/cjs/IdentifiersEntity.d.ts

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

package/lib/cjs/List.d.ts

@@ -0,0 +1,25 @@
+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/lib/cjs/ListCategory.d.ts

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