@squiz/job-runner-lib 1.66.2 → 2.2.0

package/lib/domains/job/services/JobUploadService/utils/scanWatcher.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { AxiosInstance } from 'axios';
+/**
+ * Watch and wait for upload and scan to complete
+ * @param apiClient - Axios client for API calls
+ * @param endpoint - API endpoint to poll
+ * @param id - Upload ID to check
+ * @returns Promise that resolves when scan is complete
+ */
+export declare function watchAndWaitForUploadAndScanComplete(apiClient: AxiosInstance, endpoint: string, id: string): Promise<void>;

package/lib/domains/job/services/JobUploadService/utils/scanWatcher.spec.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export {};

package/lib/domains/job/services/JobUploadService/utils/uploadInitializer.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { Logger } from '@squiz/dx-logger-lib';
+import { AxiosInstance } from 'axios';
+export interface InitialUpload {
+    zip: string;
+    upload: any;
+}
+/**
+ * Initialize upload by zipping folder and creating upload request
+ * @param apiClient - Axios client for API calls
+ * @param folderPath - Path to the job folder
+ * @param tmpDir - Temporary directory for zip file
+ * @param logger - Logger instance
+ * @returns Upload information
+ */
+export declare function initializeUpload(apiClient: AxiosInstance, folderPath: string, tmpDir: string, logger: Logger): Promise<InitialUpload>;

package/lib/domains/job/services/JobUploadService/utils/uploadInitializer.spec.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export {};

package/lib/domains/job/services/JobUploadService/utils/versionChecker.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { AxiosInstance } from 'axios';
+/**
+ * Check if a job version already exists
+ * @param apiClient - Axios client for API calls
+ * @param endpoint - API endpoint to check
+ * @returns True if version exists, false otherwise
+ */
+export declare function checkIfVersionExists(apiClient: AxiosInstance, endpoint: string): Promise<boolean>;

package/lib/domains/job/services/JobUploadService/utils/versionChecker.spec.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export {};

package/lib/domains/job/services/index.d.ts

@@ -1 +1,5 @@
+export * from './JobContextService/JobContextService';
 export * from './JobExecutionTaskService/JobExecutionTaskService';
+export * from './JobManifestService/JobManifestService';
+export * from './JobQueueService/JobQueueService';
+export * from './JobUploadService/JobUploadService';

package/lib/domains/job/singletonProvider.d.ts

@@ -3,4 +3,4 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { interfaces } from 'inversify';
-export declare const provideSingleton: <T>(identifier: interfaces.ServiceIdentifier<T>) => (target: any) => any;
+export declare const provideSingleton: <T>(identifier: interfaces.ServiceIdentifier<T>) => ((target: any) => any);

package/lib/domains/job/transientProvider.d.ts

@@ -3,4 +3,4 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { interfaces } from 'inversify';
-export declare const provideTransient: <T>(identifier: interfaces.ServiceIdentifier<T>) => (target: any) => any;
+export declare const provideTransient: <T>(identifier: interfaces.ServiceIdentifier<T>) => ((target: any) => any);

package/lib/domains/job/utils/GetAwsTags/GetAwsTags.d.ts

@@ -0,0 +1,2 @@
+import { GetAwsTagsProps } from './GetAwsTags.types';
+export declare const getAwsTags: (props: GetAwsTagsProps) => Record<string, string>;

package/lib/domains/job/utils/GetAwsTags/GetAwsTags.types.d.ts

@@ -0,0 +1,18 @@
+export type GetAwsTagsProps = {
+    /**
+     * The short environment name, eg: dev/stg/prod.
+     */
+    environment: string;
+    /**
+     * The AWS region name, eg: ap-southeast-2, us-east-1.
+     */
+    region: string;
+    /**
+     * The tenant to tag the resource with (undefined for shared resources).
+     */
+    tenant?: string;
+    /**
+     * The product the resource relates to (defaults to "job-runner").s
+     */
+    product?: string;
+};

package/lib/domains/job/utils/index.d.ts

@@ -1,3 +1,5 @@
+export * from './GetAwsTags/GetAwsTags';
+export * from './GetAwsTags/GetAwsTags.types';
 export * from './SlackClient/SlackClient';
 export * from './SlackClient/types/SlackClient.types';
 export * from './SortByTimeQueued/SortByTimeQueued';

package/lib/domains/manifest/ManifestModel.d.ts

@@ -1,7 +1,5 @@
 import { MANIFEST_MODELS } from '@squiz/dx-json-schema-lib';
-import { ManifestV1 } from './ManifestV1';
-export type ManifestV1Model = MANIFEST_MODELS.v1.ComponentManifest;
-export type ManifestModel = ManifestV1Model;
-export type Manifest = ManifestV1;
 export type JobManifestV1Model = MANIFEST_MODELS.JobV1.JobManifest;
 export type JobManifestModel = JobManifestV1Model;
+export type SchemaVersions = keyof typeof MANIFEST_MODELS;
+export declare const JOB_SCHEMA_VERSIONS: string[];

package/lib/domains/manifest/index.d.ts

@@ -1,16 +1,7 @@
-export * from './services/AbstractManifestService';
 export * from './services/ManifestServiceForDev';
-export * from './services/ManifestServiceForProduction';
-export * from './services/ComponentFunctionService';
 export * from './services/JobFunctionService';
-export * from './utils/assertFuncEntryFilesAreValid';
-export * from './utils/assertStaticFilesAreValid';
-export * from './utils/getAndAssertManifestVersion';
 export * from './utils/getAndAssertJobManifestVersion';
 export * from './utils/isValidManifestVersion';
-export * from './AbstractManifest';
 export * from './ManifestModel';
-export * from './ManifestV1';
 export * from '../job/manifest/JobManifestV1';
-export * from './errors/ManifestLocationError';
 export * from './errors/ManifestValidationError';

package/lib/domains/manifest/services/ComponentSchemaValidationService.d.ts

@@ -1,5 +1,6 @@
-import { JSONSchemaService, SquizImageType, SquizLinkType, BaseFormattedTextType } from '@squiz/dx-json-schema-lib';
-export type ComponentSchemaValidationService = JSONSchemaService<SquizImageType | SquizLinkType | BaseFormattedTextType, never>;
-export declare class ComponentSchemaValidationServiceFactory {
-    static create(): ComponentSchemaValidationService;
+import { JSONSchemaService } from '@squiz/dx-json-schema-lib';
+import { AnyPrimitiveType } from '@squiz/dx-json-schema-lib/src/jsonTypeResolution/TypeResolver';
+export type JobSchemaValidationService = JSONSchemaService<AnyPrimitiveType, never>;
+export declare class JobSchemaValidationServiceFactory {
+    static create(): JobSchemaValidationService;
 }

package/lib/domains/manifest/services/ManifestServiceForDev.d.ts

@@ -1,18 +1,12 @@
-import { AbstractManifestService } from './AbstractManifestService';
+import { JobManifestModel } from '../ManifestModel';
+import { JobManifestV1 } from '../../job/manifest/JobManifestV1';
+import { JsonValidationService } from '@squiz/dx-json-schema-lib';
 import { Logger } from '@squiz/dx-logger-lib';
-import { Manifest } from '../ManifestModel';
-type ManifestAndPath = {
-    directory: string;
-    manifest: Manifest;
-};
-export declare class ManifestServiceForDev extends AbstractManifestService {
-    protected componentMountPoint: string;
+export declare class ManifestServiceForDev {
     protected logger: Logger;
-    protected foundManifests: ManifestAndPath[];
-    constructor(componentMountPoint: string, logger: Logger);
-    listAllComponentManifests(): Promise<Manifest[]>;
-    getManifestPath(namespace: string, componentName: string, version: string): Promise<string>;
-    protected recursivelyLookForManifests(directory: string, nesting?: number): Promise<ManifestAndPath[]>;
-    protected tryToReadManifest(manifestPath: string): Promise<Manifest | undefined>;
+    protected jobValidationService: JsonValidationService;
+    constructor(logger: Logger);
+    protected getJobManifest(manifestModel: JobManifestModel, manifestPath: string): JobManifestV1;
+    readJobManifest(manifestPath: string): Promise<JobManifestV1>;
+    protected assertJobManifestMeetsSchemaVersion(manifest: JobManifestModel, schemaVersionRegex: RegExp): Promise<void>;
 }
-export {};

package/lib/domains/manifest/utils/getAndAssertJobManifestVersion.d.ts

@@ -1,3 +1,2 @@
-import { SchemaVersions } from '../AbstractManifest';
-import { JobManifestModel } from '../ManifestModel';
+import { SchemaVersions, JobManifestModel } from '../ManifestModel';
 export declare function getAndAssertJobManifestVersion(manifest: JobManifestModel, schemaRegexp?: RegExp): SchemaVersions;

package/lib/domains/manifest/utils/isValidManifestVersion.d.ts

@@ -1,2 +1,2 @@
-import { SchemaVersions } from '../AbstractManifest';
+import { SchemaVersions } from '../ManifestModel';
 export declare function isValidManifestVersion(item: unknown): item is SchemaVersions;

package/lib/index.d.ts

@@ -1,9 +1,4 @@
 export * from './domains/manifest/ManifestModel';
-export * from './domains/db';
-export * from './domains/component-set';
 export * from './domains/component';
 export * from './domains/job';
-export * from './domains/content';
-export * from './domains/url';
 export * from './domains/manifest';
-export * as TestHelpers from './TestHelpers';