@finos/legend-server-showcase/src/Showcase.ts

Legend Showcase server client

/**
 * Copyright (c) 2020-present, Goldman Sachs
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { SerializationFactory, uuid } from '@finos/legend-shared';
import { createModelSchema, optional, primitive } from 'serializr';

export class ShowcaseMetadata {
  readonly uuid = uuid();

  title!: string;
  path!: string;
  description?: string | undefined;
  development?: boolean;

  static readonly serialization = new SerializationFactory(
    createModelSchema(ShowcaseMetadata, {
      description: optional(primitive()),
      path: primitive(),
      title: primitive(),
      development: optional(primitive()),
    }),
  );
}

export class Showcase {
  title!: string;
  path!: string;
  description?: string | undefined;
  code!: string;
  documentation?: string | undefined;
  development?: boolean;

  static readonly serialization = new SerializationFactory(
    createModelSchema(Showcase, {
      code: primitive(),
      description: optional(primitive()),
      documentation: optional(primitive()),
      path: primitive(),
      title: primitive(),
      development: optional(primitive()),
    }),
  );
}