jfrog-workers 0.1.0

package/event/AFTER_BUILD_INFO_SAVE.ts

@@ -0,0 +1,62 @@
+import { Status } from './commons';
+
+export interface AfterBuildInfoSaveRequest {
+    /** Various immutable build run details */
+    build: DetailedBuildRun | undefined;
+}
+
+export interface DetailedBuildRun {
+    name: string;
+    number: string;
+    started: string;
+    buildAgent: string;
+    agent: string;
+    durationMillis: number;
+    principal: string;
+    artifactoryPrincipal: string;
+    url: string;
+    parentName: string;
+    parentNumber: string;
+    buildRepo: string;
+    modules: Module[];
+    releaseStatus: string;
+    promotionStatuses: PromotionStatus[];
+}
+
+export interface Module {
+    id: string;
+    artifacts: Artifact[];
+    dependencies: Dependency[];
+}
+
+export interface Artifact {
+    name: string;
+    type: string;
+    sha1: string;
+    sha256: string;
+    md5: string;
+    remotePath: string;
+    properties: string;
+}
+
+export interface Dependency {
+    id: string;
+    scopes: string;
+    requestedBy: string;
+}
+
+export interface PromotionStatus {
+    status: string;
+    comment: string;
+    repository: string;
+    timestamp: string;
+    user: string;
+    ciUser: string;
+}
+
+export interface AfterBuildInfoSaveResponse {
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus: Status;
+}

package/event/AFTER_CREATE.ts

@@ -0,0 +1,19 @@
+import { Header, UploadMetadata, Status, UserContext } from './commons';
+
+export interface AfterCreateRequest {
+    /** Various immutable upload metadata */
+    metadata:
+            | UploadMetadata
+            | undefined;
+    /** The immutable request headers */
+    headers: { [key: string]: Header };
+    /** The user context which sends the request */
+    userContext: UserContext | undefined;
+}
+
+export interface AfterCreateResponse {
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus?: Status;
+}

package/event/AFTER_DOWNLOAD.ts

@@ -0,0 +1,19 @@
+import { Header, DownloadMetadata, Status, UserContext } from './commons';
+
+export interface AfterDownloadRequest {
+    /** Various immutable download metadata */
+    metadata:
+            | DownloadMetadata
+            | undefined;
+    /** The immutable request headers */
+    headers: { [key: string]: Header };
+    /** The user context which sends the request */
+    userContext: UserContext | undefined;
+}
+
+export interface AfterDownloadResponse {
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus?: Status;
+}

package/event/AFTER_MOVE.ts

@@ -0,0 +1,19 @@
+import { ArtifactProperties, UploadMetadata, RepoPath, Status, UserContext } from './commons';
+
+export interface AfterMoveRequest {
+    /** Various immutable upload metadata */
+    metadata: UploadMetadata | undefined;
+    /** The immutable target repository path */
+    targetRepoPath: RepoPath | undefined;
+    /** The user context which sends the request */
+    userContext: UserContext | undefined;
+    /** The moved artifacts properties */
+    artifactProperties: { [key: string]: ArtifactProperties };
+}
+
+export interface AfterMoveResponse {
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus?: Status;
+}

package/event/BEFORE_DOWNLOAD.ts

@@ -0,0 +1,33 @@
+import { Header, DownloadMetadata, RepoPath, Status, UserContext } from './commons';
+
+export interface BeforeDownloadRequest {
+    /** Various immutable download metadata */
+    metadata:
+            | DownloadMetadata
+            | undefined;
+    /** The immutable request headers */
+    headers: { [key: string]: Header };
+    /** The user context which sends the request */
+    userContext:
+            | UserContext
+            | undefined;
+    /** The response repoPath */
+    repoPath: RepoPath | undefined;
+}
+
+export interface BeforeDownloadResponse {
+    /** The instruction of how to proceed */
+    status: DownloadStatus;
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus?: Status;
+}
+
+export enum DownloadStatus {
+    DOWNLOAD_UNSPECIFIED = 0,
+    DOWNLOAD_PROCEED = 1,
+    DOWNLOAD_STOP = 2,
+    DOWNLOAD_WARN = 3,
+    UNRECOGNIZED = -1,
+}

package/event/BEFORE_UPLOAD.ts

@@ -0,0 +1,36 @@
+import { Header, RepoType, RepoPath, Status, UserContext, ArtifactProperties, UploadMetadata } from './commons';
+
+export interface BeforeUploadRequest {
+    /** Various immutable upload metadata */
+    metadata:
+            | UploadMetadata
+            | undefined;
+    /** The immutable request headers */
+    headers: { [key: string]: Header };
+    /** The user context which sends the request */
+    userContext:
+            | UserContext
+            | undefined;
+    /** The properties of the request */
+    artifactProperties: { [key: string]: ArtifactProperties };
+}
+
+export interface BeforeUploadResponse {
+    /** The instruction of how to proceed */
+    status: UploadStatus;
+    /** Message to print to the log, in case of an error it will be printed as a warning */
+    message: string;
+    /** The modified repo path from the worker */
+    modifiedRepoPath:
+            | RepoPath
+            | undefined;
+    /** Indicates whether worker execution succeeded or failed */
+    executionStatus?: Status;
+}
+
+export enum UploadStatus {
+    UPLOAD_UNSPECIFIED = 0,
+    UPLOAD_PROCEED = 1,
+    UPLOAD_STOP = 2,
+    UPLOAD_WARN = 3,
+}

package/event/commons.ts

@@ -0,0 +1,109 @@
+export interface Header {
+  value: string[];
+}
+
+export interface UserContext {
+  /** The username or subject */
+  id: string;
+  /** Is the context an accessToken */
+  isToken: boolean;
+  /** The realm of the user */
+  realm: string;
+}
+
+export interface RepoPath {
+  /** The repo key */
+  key: string;
+  /** The path itself */
+  path: string;
+  /** The key:path combination */
+  id: string;
+  /** Is the path the root */
+  isRoot: boolean;
+  /** Is the path a folder */
+  isFolder: boolean;
+}
+
+export enum RepoType {
+  REPO_TYPE_UNSPECIFIED = 0,
+  REPO_TYPE_LOCAL = 1,
+  REPO_TYPE_REMOTE = 2,
+  REPO_TYPE_FEDERATED = 3,
+  UNRECOGNIZED = -1,
+}
+
+export enum Status {
+  STATUS_UNSPECIFIED = 0,
+  STATUS_SUCCESS = 4,
+  STATUS_FAIL = 2,
+  UNRECOGNIZED = -1,
+}
+
+export interface ArtifactProperties {
+  /** The property values */
+  value: string[];
+}
+
+export interface DownloadMetadata {
+  /** The repoPath object of the request */
+  repoPath:
+    | RepoPath
+    | undefined;
+  /** The original repo path in case a virtual repo is involved */
+  originalRepoPath:
+    | RepoPath
+    | undefined;
+  /** The file name from path */
+  name: string;
+  /** Is it a head request */
+  headOnly: boolean;
+  /** Is it a checksum request */
+  checksum: boolean;
+  /** Is it a recursive request */
+  recursive: boolean;
+  /** When a modification has occurred */
+  modificationTime: number;
+  /** Is it a directory request */
+  directoryRequest: boolean;
+  /** Is it a metadata request */
+  metadata: boolean;
+  /** Last modification time that occurred */
+  lastModified: number;
+  /** If a modification happened since the last modification time */
+  ifModifiedSince: number;
+  /** The url that points to artifactory */
+  servletContextUrl: string;
+  /** The request URI */
+  uri: string;
+  /** The client address */
+  clientAddress: string;
+  /** The resource path of the requested zip */
+  zipResourcePath: string;
+  /** Is the request a zip resource request */
+  zipResourceRequest: boolean;
+  /** should replace the head request with get */
+  replaceHeadRequestWithGet: boolean;
+  /** Repository type */
+  repoType: RepoType;
+}
+
+export interface UploadMetadata {
+  /** The repoPath object of the request */
+  repoPath:
+    | RepoPath
+    | undefined;
+  /** The deploy request content length */
+  contentLength: number;
+  /** Last modification time that occurred */
+  lastModified: number;
+  /** Is the request trusting the server checksums */
+  trustServerChecksums: boolean;
+  /** The url that points to artifactory */
+  servletContextUrl: string;
+  /** Is it a request that skips jar indexing */
+  skipJarIndexing: boolean;
+  /** Is redirect disabled on this request */
+  disableRedirect: boolean;
+  /** Repository type */
+  repoType: RepoType;
+}

package/index.ts

@@ -0,0 +1,86 @@
+import { AxiosInstance } from "axios";
+
+/**
+ * Response returned by JFrog platform API
+ */
+export interface IPlatformHttpResponse {
+  /**
+   * Http status
+   */
+  status: number;
+  /**
+   * Response headers
+   */
+  headers: Record<string, string>;
+  /**
+   * Parsed response body
+   */
+  data: any;
+}
+
+/**
+ *  PlatformHttpClient allows performing REST requests to JFrog platform APIs.
+ *  The client encapsulates platform scheme, hostname and port. Client can add Authorization header with
+ *  admin token and other additional headers (E.g. X-Jfrog-Tenant-Id header with proper tenant id in multi-tenant
+ *  environment). User provides only the path for the request, body, http method, additional headers.
+ */
+export interface PlatformHttpClient {
+  /**
+   * Perform http GET request to JFrog platform
+   * @param {string} endpoint - API endpoint. E.g. /artifactory/api/repositories
+   * @param {Record<string, string>} headers - additional headers used in the request
+   */
+  get(endpoint: string, headers?: Record<string, string>): Promise<IPlatformHttpResponse>;
+
+  /**
+   * Perform http POST request to JFrog platform
+   * @param {string} endpoint - API endpoint. E.g. /artifactory/api/repositories
+   * @param {any} requestData - data sent in request body
+   * @param {Record<string, string>} headers - additional headers used in the request
+   */
+  post(endpoint: string, requestData?: any, headers?: Record<string, string>): Promise<IPlatformHttpResponse>;
+
+  /**
+   * Perform http PUT request to JFrog platform
+   * @param {string} endpoint - API endpoint. E.g. /artifactory/api/repositories
+   * @param {any} requestData - data sent in request body
+   * @param {Record<string, string>} headers - additional headers used in the request
+   */
+  put(endpoint: string, requestData?: any, headers?: Record<string, string>): Promise<IPlatformHttpResponse>;
+
+  /**
+   * Perform http PATCH request to JFrog platform
+   * @param {string} endpoint - API endpoint. E.g. /artifactory/api/repositories
+   * @param {any} requestData - data sent in request body
+   * @param {Record<string, string>} headers - additional headers used in the request
+   */
+  patch(endpoint: string, requestData?: any, headers?: Record<string, string>): Promise<IPlatformHttpResponse>;
+
+  /**
+   * Perform http DELETE request to JFrog platform
+   * @param {string} endpoint - API endpoint. E.g. /artifactory/api/repositories
+   * @param {Record<string, string>} headers - additional headers used in the request
+   */
+  delete(endpoint: string, headers?: Record<string, string>): Promise<IPlatformHttpResponse>;
+}
+
+export interface PlatformClients {
+  platformHttp: PlatformHttpClient;
+  axios: Pick<AxiosInstance, 'get'|'put'|'post'|'delete'|'head'|'patch'|'request'>;
+}
+
+export interface PlatformContext {
+  platformToken: string
+  clients: PlatformClients
+  secrets: Record<string, string>
+}
+
+export * from './event/commons';
+export * from './event/AFTER_CREATE';
+export * from './event/AFTER_BUILD_INFO_SAVE';
+export * from './event/AFTER_DOWNLOAD';
+export * from './event/AFTER_MOVE';
+export * from './event/AFTER_DOWNLOAD';
+export * from './event/BEFORE_DOWNLOAD';
+export * from './event/BEFORE_UPLOAD';
+export * from './event/AFTER_CREATE';

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "jfrog-workers",
+  "version": "0.1.0",
+  "description": "JFrog workers interfaces and stubs",
+  "homepage": "https://github.com/jfrog/workers-sample",
+  "contributors": [
+    {
+      "name": "HERVE ESTEGUET",
+      "githubUsername": "ehl-jf",
+      "url": "https://github.com/ehl-jf"
+    }
+  ],
+  "main": "index.ts",
+  "author": "JFrog",
+  "license": "ISC",
+  "exports": {
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jfrog/workers-sample.git"
+  },
+  "dependencies": {
+    "axios": "1.6.7"
+  },
+  "devDependencies": {
+    "typescript": "^5.4.2"
+  }
+}

package/test/login.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+echo "always-auth=true" > ".npmrc"
+echo "email=${int_JFROG_NPMJS_ORG_EMAIL}" >> ".npmrc"
+npm login --auth-type legacy << EOF
+ehl-jf
+g&m&yJEdmz%1$ZMu
+hervee@jfrog.com
+EOF

package/test/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
+        "declaration": true,
+        "target": "es2017",
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": false,
+        "noFallthroughCasesInSwitch": false,
+        "lib": [
+            "ES2021.String"
+        ]
+    },
+    "include": [
+        "**/*.ts",
+        "node_modules/@types/**/*.d.ts"
+    ]
+}