@squiz/job-runner-lib 1.66.1

package/src/domains/component/repositories/ComponentVersionRepository.ts

@@ -0,0 +1,138 @@
+import { ComponentVersionInterface, ComponentVersion } from '../models/ComponentVersion';
+import { ComponentRepositories } from '../../db/ComponentRepositories';
+import { MANIFEST_MODELS } from '@squiz/dx-json-schema-lib';
+import { AbstractRepository, PageResult, Pool, SortDirection } from '@squiz/db-lib';
+import { ComponentSetComponentVersionStatus } from '../../component-set';
+
+type Icon = MANIFEST_MODELS.v1.DxComponentIconsJson;
+const SEMVER_REGEX = /^(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)$/;
+
+export interface ComponentSetComponentVersionWithDetails extends ComponentVersionInterface {
+  environmentVariables?: Record<string, string>;
+}
+
+export class ComponentVersionRepository extends AbstractRepository<ComponentVersionInterface, ComponentVersion> {
+  constructor(ops: { repositories: ComponentRepositories; pool: Pool }) {
+    super(
+      ops.repositories,
+      ops.pool,
+      'component_version',
+      {
+        componentName: 'component_name',
+        version: 'version',
+        description: 'description',
+        displayName: 'display_name',
+        icon: 'icon',
+      },
+      ComponentVersion,
+    );
+  }
+
+  async getPaginatedMaxComponentVersion(
+    pageNumber: number,
+    sortBy: (keyof ComponentVersionInterface)[],
+    sortDirection: SortDirection,
+    pageSize: number | null = null,
+    searchFields: Partial<Omit<ComponentVersionInterface, 'icon'>> | null = null,
+  ): Promise<PageResult<ComponentVersionInterface>> {
+    const tableRef = 'cv_top';
+    const whereClause = `
+      WHERE string_to_array(cv_top.version, '.')::int[] IN (
+        SELECT string_to_array(cv_inner.version, '.')::int[] AS mx
+        FROM component_version cv_inner
+        WHERE cv_top.component_name = cv_inner.component_name
+        ORDER BY string_to_array(version, '.')::int[] desc
+        LIMIT 1
+      )
+    `;
+
+    const pageResult = await this.getPageRaw(
+      pageNumber,
+      sortBy,
+      sortDirection,
+      whereClause,
+      tableRef,
+      [],
+      pageSize,
+      searchFields,
+    );
+
+    return pageResult;
+  }
+
+  async getComponentSetComponentVersionByWebPath(
+    webPath: string,
+    status?: ComponentSetComponentVersionStatus,
+  ): Promise<ComponentSetComponentVersionWithDetails[]> {
+    let whereClause = '';
+
+    const bindVars = [webPath];
+    if (status !== undefined) {
+      whereClause = `AND cscv.status=$2`;
+      bindVars.push(status);
+    }
+
+    const sql = `
+      SELECT cv.*, cscv.env_vars
+      FROM component_version as cv     
+      JOIN component_set_component_version as cscv  ON 
+            cv.component_name = cscv.component_name AND
+            cv.version        = cscv.component_version 
+      WHERE cscv.component_set_web_path=$1 ${whereClause}`;
+
+    const result = await this.executeQueryRaw(sql, bindVars);
+
+    return result.map((a) => {
+      return {
+        componentName: a.component_name,
+        version: a.version,
+        displayName: a.display_name,
+        description: a.description,
+        icon: a.icon ? a.icon : undefined, // ternary is to coalesce null to undefined
+        environmentVariables: a.env_vars,
+      };
+    });
+  }
+
+  async getComponentByNameAndVersion(
+    componentName: string,
+    version: string,
+  ): Promise<ComponentVersionInterface | undefined> {
+    const compVersion = await this.findOne({
+      componentName: componentName,
+      version: version,
+    });
+
+    return compVersion;
+  }
+
+  async componentVersionExists(componentName: string, version: string): Promise<boolean> {
+    const comp = await this.getComponentByNameAndVersion(componentName, version);
+
+    return comp != null;
+  }
+
+  async addComponentVersion(
+    componentName: string,
+    componentVersion: string,
+    displayName: string,
+    description: string,
+    icon: Icon | undefined,
+  ): Promise<ComponentVersionInterface> {
+    if (SEMVER_REGEX.test(componentVersion) === false) {
+      throw new Error(
+        `ComponentVersion does not follow the semver convention. Component version must be in the form of major.minor.patch`,
+      );
+    }
+
+    const componentVersionModel = await this.create({
+      componentName,
+      version: componentVersion,
+      description: description || '',
+      displayName: displayName || '',
+      icon,
+    });
+
+    return componentVersionModel;
+  }
+}