jfrog-workers 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -61,17 +61,15 @@ export interface PlatformClients {
     platformHttp: PlatformHttpClient;
     axios: Pick<AxiosInstance, 'get' | 'put' | 'post' | 'delete' | 'head' | 'patch' | 'request'>;
 }
+export interface PlatformSecrets {
+    /**
+     * Retrieves a secret by its key
+     * @param {string} secretKey - The secret key
+     */
+    get(secretKey: string): string;
+}
 export interface PlatformContext {
     platformToken: string;
     clients: PlatformClients;
-    secrets: Record<string, string>;
+    secrets: PlatformSecrets;
 }
-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/dist/index.js

@@ -1,25 +1,2 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./event/commons"), exports);
-__exportStar(require("./event/AFTER_CREATE"), exports);
-__exportStar(require("./event/AFTER_BUILD_INFO_SAVE"), exports);
-__exportStar(require("./event/AFTER_DOWNLOAD"), exports);
-__exportStar(require("./event/AFTER_MOVE"), exports);
-__exportStar(require("./event/AFTER_DOWNLOAD"), exports);
-__exportStar(require("./event/BEFORE_DOWNLOAD"), exports);
-__exportStar(require("./event/BEFORE_UPLOAD"), exports);
-__exportStar(require("./event/AFTER_CREATE"), exports);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "jfrog-workers",
-  "version": "0.4.0",
-  "description": "JFrog workers interfaces and stubs",
+  "version": "0.6.0",
+  "description": "JFrog workers interfaces",
   "homepage": "https://github.com/jfrog/workers-sample",
   "contributors": [
     {
@@ -18,7 +18,8 @@
   "author": "JFrog",
   "license": "Apache-2.0",
   "scripts": {
-    "build": "tsc"
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc"
   },
   "exports": {
     ".": {

package/dist/event/AFTER_BUILD_INFO_SAVE.d.ts

@@ -1,55 +0,0 @@
-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/dist/event/AFTER_BUILD_INFO_SAVE.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/event/AFTER_CREATE.d.ts

@@ -1,17 +0,0 @@
-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/dist/event/AFTER_CREATE.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/event/AFTER_DOWNLOAD.d.ts

@@ -1,17 +0,0 @@
-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/dist/event/AFTER_DOWNLOAD.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/event/AFTER_MOVE.d.ts

@@ -1,19 +0,0 @@
-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/dist/event/AFTER_MOVE.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/event/BEFORE_DOWNLOAD.d.ts

@@ -1,28 +0,0 @@
-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 declare enum DownloadStatus {
-    DOWNLOAD_UNSPECIFIED = 0,
-    DOWNLOAD_PROCEED = 1,
-    DOWNLOAD_STOP = 2,
-    DOWNLOAD_WARN = 3,
-    UNRECOGNIZED = -1
-}

package/dist/event/BEFORE_DOWNLOAD.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DownloadStatus = void 0;
-var DownloadStatus;
-(function (DownloadStatus) {
-    DownloadStatus[DownloadStatus["DOWNLOAD_UNSPECIFIED"] = 0] = "DOWNLOAD_UNSPECIFIED";
-    DownloadStatus[DownloadStatus["DOWNLOAD_PROCEED"] = 1] = "DOWNLOAD_PROCEED";
-    DownloadStatus[DownloadStatus["DOWNLOAD_STOP"] = 2] = "DOWNLOAD_STOP";
-    DownloadStatus[DownloadStatus["DOWNLOAD_WARN"] = 3] = "DOWNLOAD_WARN";
-    DownloadStatus[DownloadStatus["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(DownloadStatus || (exports.DownloadStatus = DownloadStatus = {}));

package/dist/event/BEFORE_UPLOAD.d.ts

@@ -1,31 +0,0 @@
-import { Header, 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 declare enum UploadStatus {
-    UPLOAD_UNSPECIFIED = 0,
-    UPLOAD_PROCEED = 1,
-    UPLOAD_STOP = 2,
-    UPLOAD_WARN = 3
-}

package/dist/event/BEFORE_UPLOAD.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UploadStatus = void 0;
-var UploadStatus;
-(function (UploadStatus) {
-    UploadStatus[UploadStatus["UPLOAD_UNSPECIFIED"] = 0] = "UPLOAD_UNSPECIFIED";
-    UploadStatus[UploadStatus["UPLOAD_PROCEED"] = 1] = "UPLOAD_PROCEED";
-    UploadStatus[UploadStatus["UPLOAD_STOP"] = 2] = "UPLOAD_STOP";
-    UploadStatus[UploadStatus["UPLOAD_WARN"] = 3] = "UPLOAD_WARN";
-})(UploadStatus || (exports.UploadStatus = UploadStatus = {}));

package/dist/event/commons.d.ts

@@ -1,96 +0,0 @@
-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 declare enum RepoType {
-    REPO_TYPE_UNSPECIFIED = 0,
-    REPO_TYPE_LOCAL = 1,
-    REPO_TYPE_REMOTE = 2,
-    REPO_TYPE_FEDERATED = 3,
-    UNRECOGNIZED = -1
-}
-export declare 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/dist/event/commons.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Status = exports.RepoType = void 0;
-var RepoType;
-(function (RepoType) {
-    RepoType[RepoType["REPO_TYPE_UNSPECIFIED"] = 0] = "REPO_TYPE_UNSPECIFIED";
-    RepoType[RepoType["REPO_TYPE_LOCAL"] = 1] = "REPO_TYPE_LOCAL";
-    RepoType[RepoType["REPO_TYPE_REMOTE"] = 2] = "REPO_TYPE_REMOTE";
-    RepoType[RepoType["REPO_TYPE_FEDERATED"] = 3] = "REPO_TYPE_FEDERATED";
-    RepoType[RepoType["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(RepoType || (exports.RepoType = RepoType = {}));
-var Status;
-(function (Status) {
-    Status[Status["STATUS_UNSPECIFIED"] = 0] = "STATUS_UNSPECIFIED";
-    Status[Status["STATUS_SUCCESS"] = 4] = "STATUS_SUCCESS";
-    Status[Status["STATUS_FAIL"] = 2] = "STATUS_FAIL";
-    Status[Status["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
-})(Status || (exports.Status = Status = {}));