@codenotch/codenotch.cli 1.0.33 → 1.0.34

package/src/models/DbModels.ts

@@ -1,428 +0,0 @@
-import { JSONSchema7 } from "json-schema";
-
-export enum FieldType {
-    STRING,
-    NUMBER, // Float
-    INTEGER,
-    BOOL,
-    LIST,  // aka array
-    MAP // aka object
-}
-/**
- * Used only to save JSON .table file in scenar.io later 
- * given to DatabaseMigrationGenerator to compute XML migration
- */
-export interface TableDefinition {
-    Name: string;
-    Description: string;
-
-    Id: IdField;
-    CreatedAt: CreatedAtField;
-    UpdatedAt: UpdatedAtField;
-
-    Fields?: BaseFieldType[];
-
-    AccessPolicy: ContainerAccessSettings,
-    RetentionPolicy: ContainerRetentionPolicy,
-    PatchSettings: ContainerPatchSettings
-}
-
-/**
- * All SQL field types
- */
-export enum FieldTypes {
-    Guid = "Guid",
-    Boolean = "Boolean",
-    String = "String",
-    Text = "Text",
-    Email = "Email",
-    Decimal = "Decimal",
-    Integer = "Integer",
-    Date = "Date",
-    DateTime = "DateTime",
-    Version = "Version",
-    Enum = "Enum",
-    AutoIncrement = "AutoIncrement",
-    HasMany = "HasMany",
-    HasOne = "HasOne",
-    BelongsTo = "BelongsTo"
-}
-
-export interface IdField {
-    Name: string;
-}
-
-export interface BaseFieldType {
-    Name: string;
-    Description: string;
-    Type: FieldTypes;
-    IsNullable: boolean;
-    IsUnique: boolean;
-    IsSecret: boolean;
-    IsIndexed: boolean;
-    IsValidated: boolean;
-    Validation: string;
-}
-
-export interface BaseRelation extends BaseFieldType {
-    Table: string;
-}
-
-export interface HasRelation extends BaseRelation {
-    BelongsTo: string;
-    LinkBehaviour: "Unlink" | "Delete" | string;
-}
-
-export interface HasOne extends HasRelation {
-
-}
-
-export interface HasMany extends HasRelation {
-
-}
-
-export interface BelongsTo extends BaseRelation {
-    Key: string
-}
-
-export interface GuidField extends BaseFieldType {
-
-}
-
-/**
- * Contains email with autovalidation
- */
-export interface EmailField extends BaseFieldType {
-
-}
-
-/**
- * Special SQL timestamp
- */
-export interface VersionField extends BaseFieldType {
-
-}
-
-/**
- * Contains date + time
- */
-export interface DateTimeField extends BaseFieldType {
-
-}
-
-/**
- * Contains date
- */
-export interface DateField extends BaseFieldType {
-
-}
-
-/**
- * Array of string
- */
-export interface EnumField extends BaseFieldType {
-    /**
-     * 
-     */
-    Value: string[];
-}
-
-/**
- * Any number with Precision (How many floating numbers) and Scale (Max integer part)
- */
-export interface DecimalField extends BaseFieldType {
-    /**
-     * 
-     */
-    Precision: number;
-    /**
-     * 
-     */
-    Scale: number;
-}
-
-/**
- * No floating number value
- */
-export interface IntegerField extends BaseFieldType {
-
-    // Tiny, Small, Normal (default), Big
-    Size: string | undefined;
-
-}
-
-/**
- * String > of 16b
- */
-export interface TextField extends BaseFieldType {
-
-}
-
-/**
- * Equivalent of VARCHAR(255)
- */
-export interface StringField extends BaseFieldType {
-
-}
-
-/**
- * Contains true false as a bit
- */
-export interface BooleanField extends BaseFieldType {
-
-}
-
-/**
- * An integer column that is auto incremented
- */
-export interface AutoIncrementField extends BaseFieldType {
-    /**
-     * Start value
-     */
-    Seed: number;
-
-    /**
-     * 
-     */
-    Increment: number;
-
-    UseBigInt?: boolean;
-}
-
-/**
- * 
- */
-export interface UpdatedAtField {
-    Name: string;
-}
-
-/**
- * 
- */
-export interface CreatedAtField {
-    Name: string;
-}
-
-export enum ContainerType {
-    Document = "0",
-    Sql = "1"
-}
-
-// Abstraction of datastore container, provide a way to use any type of container, blob storage, sql, etc
-export default class AbstractRecordContainer {
-
-    // Name and identifier
-    name: string;
-    dataSourceKind: ContainerType;
-    schema: JSONSchema7;
-
-    accessPolicy: ContainerAccessSettings;
-    retentionPolicy: ContainerRetentionPolicy;
-    patchSettings: ContainerPatchSettings;
-    secretFields: string[];
-
-    public constructor(name: string, type: ContainerType, schema: JSONSchema7, accessSettings?: ContainerAccessSettings, retentionPolicy?: ContainerRetentionPolicy, patchSettings?: ContainerPatchSettings, secretFields?: string[]) {
-        this.name = name;
-        this.dataSourceKind = type;
-        this.schema = schema;
-
-        if (accessSettings && accessSettings.public === undefined) {
-            accessSettings = undefined;
-        }
-
-        if (accessSettings) {
-            this.accessPolicy = accessSettings;
-        }
-        else {
-            this.accessPolicy = {
-                public: {
-                    read: 'all',
-                    update: 'all',
-                    create: 'all',
-                    delete: 'all'
-                },
-                external: {
-                    read: 'all',
-                    update: 'all',
-                    create: 'all',
-                    delete: 'all'
-                },
-                internal: {
-                    _other: {
-                        read: 'all',
-                        update: 'all',
-                        create: 'all',
-                        delete: 'all'
-                    },
-                    admin: {
-                        read: 'all',
-                        update: 'all',
-                        create: 'all',
-                        delete: 'all'
-                    },
-                    dev: {
-                        read: 'all',
-                        update: 'all',
-                        create: 'all',
-                        delete: 'all'
-                    }
-                },
-                system: {
-
-                }
-            };
-        }
-
-        if (retentionPolicy) {
-            this.retentionPolicy = retentionPolicy;
-        }
-        else {
-            this.retentionPolicy = {
-                RetentionPeriod: null, // default is to never expires
-                RetentionReachedBehaviour: "DELETE"
-            }
-        }
-
-        if (patchSettings) {
-            this.patchSettings = patchSettings;
-        }
-        else {
-            this.patchSettings = {
-                PatchExpirationMinutes: 1440,
-                PatchRetentionAmount: 10
-            }
-        }
-
-        if (secretFields) {
-            this.secretFields = secretFields;
-        }
-        else {
-            this.secretFields = [];
-        }
-    }
-
-    // Used to display a little tag in the UI
-    public getTag(): string {
-        switch (this.dataSourceKind) {
-            case ContainerType.Document: return "json";
-            case ContainerType.Sql: return "sql";
-        }
-    }
-}
-export interface CrudAccessSetting {
-
-    read: 'all' | 'rls' | 'none';
-
-    update: 'all' | 'rls' | 'none';
-
-    delete: 'all' | 'rls' | 'none';
-
-    create: 'all' | 'none';
-}
-
-export interface ContainerAccessSettings {
-
-    internal: { [scope: string]: CrudAccessSetting; };
-    public: CrudAccessSetting;
-    external: CrudAccessSetting;
-    system: { [serviceName: string]: CrudAccessSetting; };
-}
-
-export interface ContainerRetentionPolicy {
-
-    /**
-    * The time after which the data is purged from the datasource
-    * If null, data never expires
-    * Default to null
-    */
-    RetentionPeriod: string | null;
-
-    /**
-     * Describes the behaviour of the data upon reaching the retention period 
-    */
-    RetentionReachedBehaviour: "DELETE"; // TODO for the moment, only DELETE is supported
-}
-
-
-export interface ContainerPatchSettings {
-
-    /**
-     * Time (in minutes) after which a patch can no longer be compensated
-     */
-    PatchExpirationMinutes: number;
-
-    /**
-     * Maximum amount of non-merged patches
-     * When this number is reached, the oldest patch is merged and can no longer be compensated
-     * 0 means no patch are kept for this datastore (the grain still keep a copy of the latest version of the record though)
-     */
-    PatchRetentionAmount: number
-}
-
-/*
-export class DatabaseSchemaGenerator {
-    static GetXMLFromTableDefinition(definitions: TableDefinition[], version: string = "0.0.1"): string {
-
-        let DatabaseSchema: any = {
-            Tables: {
-                Table: []
-            },
-            "@": { Version: version }
-        };
-
-        definitions.forEach(definition => {
-            let definitionModel: any = {
-                "@": {
-                    Name: definition.Name,
-                    Description: definition.Description
-                },
-                Id: {
-                    "@": {
-                        Name: definition.Id.Name,
-                    }
-                },
-                CreatedAt: {
-                    "@": {
-                        Name: definition.CreatedAt.Name,
-                    }
-                },
-                UpdatedAt: {
-                    "@": {
-                        Name: definition.UpdatedAt.Name,
-                    }
-                }
-            }
-            definition.Fields?.forEach(field => {
-                let resultfield: any = {
-                    "@": Object.assign({}, field)
-                }
-                delete resultfield["@"].Type;
-
-                if (field.Type === FieldTypes.Enum) {
-                    resultfield["Value"] = resultfield["@"].Value;
-                    delete resultfield["@"].Value;
-                }
-
-                if (Array.isArray(definitionModel[field.Type])) {
-                    definitionModel[field.Type].push(resultfield);
-                } else if (definitionModel[field.Type]) {
-                    definitionModel[field.Type] = [definitionModel[field.Type]];
-                    definitionModel[field.Type].push(resultfield);
-                } else {
-                    definitionModel[field.Type] = resultfield
-                }
-            })
-            DatabaseSchema.Tables.Table.push(definitionModel)
-
-        });
-
-        let result = parse("DatabaseSchema", DatabaseSchema, { format: { doubleQuotes: true } })
-        return result;
-    }
-}
-*/
-
-export interface DatabaseSchema {
-
-    Tables: TableDefinition[];
-}

package/src/models/OpenApiModels.ts

@@ -1,145 +0,0 @@
-import { JSONSchema7 } from "json-schema";
-
-export interface IOpenApiSchemaRef { schema: { '$ref': string } }
-export interface IOpenApiResponse {
-    description?: string;
-    content?: { [type: string]: IOpenApiSchemaRef }
-}
-export interface IOpenApiEndpoint {
-    description?: string;
-    operationId?: string;
-    responses?: { [code: string]: IOpenApiResponse };
-    parameters?: IOpenApiParameter[];
-    requestBody?: {
-        content: { [type: string]: IOpenApiSchemaRef };
-        description?: string;
-    };
-}
-
-export interface IOpenApiParameter {
-    description?: string;
-    in: string;
-    name: string;
-    required: boolean;
-    schema: JSONSchema7;
-}
-
-
-/**
- * Open api version 3.0
- */
-export default class OpenAPISpec {
-    /**
-     * Describe open API version
-     */
-    openapi: string;
-    /**
-     * Api information
-     * version, title and license
-     */
-    info: APIInfo;
-
-    /**
-     * List of API paths
-     */
-    paths: any;
-
-    components?: {
-        schemas?: { [name: string]: JSONSchema7 }
-    };
-
-    /**
-     * constructor
-     */
-    constructor() {
-        this.openapi = "3.0.0";
-        this.info = new APIInfo();
-        this.paths = {};
-    }
-
-
-
-}
-
-/**
- * API information specification
- */
-export class APIInfo {
-    /**
-     * API Version
-     */
-    version: string;
-    /**
-     * API Title
-     */
-    title: string;
-
-    constructor() {
-        this.version = "1.0.0";
-        this.title = "";
-    }
-}
-
-export class APIController {
-    description: string;
-
-    requestBody: any | null;
-
-    parameters: APIParameter[] | null;
-    responses: any;
-
-    constructor() {
-        this.description = "";
-        this.requestBody = null;
-        this.parameters = null;
-        this.responses = {};
-    }
-}
-
-/**
- * Api parameters use for path, inquery and headers
- */
-export class APIParameter {
-    name: string;
-    in: string;
-    schema: SchemaType | null;
-    required: boolean;
-
-    constructor() {
-        this.name = "";
-        this.in = "query";
-        this.schema = null;
-        this.required = false;
-    }
-}
-
-/**
- * Open API response definition
- */
-export class APIResponse {
-    description: string;
-    content?: { "application/json": { schema: SchemaType; }; };
-
-    constructor() {
-        this.description = "";
-    }
-
-}
-/**
- * Open API schema type definition
- */
-export class SchemaType {
-
-    type: string;
-
-    items?: object;
-
-    properties?: { [key: string]: SchemaType };
-
-    example?: string;
-
-    constructor() {
-        this.type = "";
-    }
-
-}