@relative-ci/core 5.0.0-alpha.2

package/lib/esm/utils/mask-object-property.js

@@ -0,0 +1,21 @@
+import _ from 'lodash';
+import { MASK } from '../constants.js';
+
+function maskValue(value) {
+    if (!value || !value?.toString) {
+        return MASK;
+    }
+    const text = value.toString();
+    return `${MASK}${text.substring(text.length - 6)}`;
+}
+function maskObjectProperties(data, paths) {
+    const normalizedData = _.merge({}, data);
+    paths.forEach((propertyPath) => {
+        const value = _.get(normalizedData, propertyPath, '');
+        _.set(normalizedData, propertyPath, maskValue(value));
+    });
+    return normalizedData;
+}
+
+export { maskObjectProperties };
+//# sourceMappingURL=mask-object-property.js.map

package/lib/esm/utils/mask-object-property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mask-object-property.js","sources":["../../../../src/utils/mask-object-property.ts"],"sourcesContent":[null],"names":[],"mappings":";;;AAIA,SAAS,SAAS,CAAC,KAAc,EAAA;IAC/B,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE;AAC9B,QAAA,OAAO,IAAI;;AAGb,IAAA,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE;AAC7B,IAAA,OAAO,CAAG,EAAA,IAAI,CAAG,EAAA,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE;AACpD;AAEgB,SAAA,oBAAoB,CAAC,IAA6B,EAAE,KAAoB,EAAA;IACtF,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC;AAExC,IAAA,KAAK,CAAC,OAAO,CAAC,CAAC,YAAY,KAAI;AAC7B,QAAA,MAAM,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,EAAE,EAAE,CAAC;AAErD,QAAA,CAAC,CAAC,GAAG,CAAC,cAAc,EAAE,YAAY,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;AACvD,KAAC,CAAC;AAEF,IAAA,OAAO,cAAc;AACvB;;;;"}

package/lib/esm/utils/normalize-params.js

@@ -0,0 +1,60 @@
+import { AGENT_MISSING_KEY_ERROR, AGENT_MISSING_SLUG_ERROR, AGENT_MISSING_COMMIT_ERROR, AGENT_MISSING_BRANCH_ERROR } from '../locales/en.js';
+import { DEFAULT_ENDPOINT } from '../constants.js';
+import { getEnvVars } from './get-env-vars.js';
+import { debug } from './debug.js';
+import { maskObjectProperties } from './mask-object-property.js';
+import { getCommitMessage } from './get-commit-message.js';
+
+/**
+ * Normalize ingest params based on:
+ * 1. pluign arguments
+ * 2. computed values
+ * 3. env-ci fallback
+ */
+function normalizeParams(pluginArgs, config) {
+    const envVars = getEnvVars();
+    const params = {
+        slug: pluginArgs.slug || envVars.slug,
+        branch: pluginArgs.branch || envVars.branch,
+        pr: pluginArgs.pr || envVars.pr,
+        commit: pluginArgs.commit || envVars.commit,
+        build: envVars.build,
+        buildUrl: envVars.buildUrl,
+        service: envVars.service,
+        key: envVars.key,
+        endpoint: envVars.endpoint || DEFAULT_ENDPOINT,
+        agentVersion: "5.0.0-alpha.2",
+        /**
+         * Get commit message using git if includeCommitMessage is set and
+         * the commitMessage plugin argument is missing
+         */
+        commitMessage: pluginArgs.commitMessage
+            || envVars.commitMessage
+            || (config.includeCommitMessage ? getCommitMessage() : undefined),
+    };
+    debug('normalized parameters', maskObjectProperties(params, ['key']));
+    // Validate required parameters
+    if (!params.key) {
+        throw new Error(AGENT_MISSING_KEY_ERROR);
+    }
+    if (!params.slug) {
+        throw new Error(AGENT_MISSING_SLUG_ERROR);
+    }
+    if (!params.commit) {
+        throw new Error(AGENT_MISSING_COMMIT_ERROR);
+    }
+    if (!params.branch) {
+        throw new Error(AGENT_MISSING_BRANCH_ERROR);
+    }
+    // Explicitly pass required props to allow ts to infer correctly
+    return {
+        ...params,
+        key: params.key,
+        slug: params.slug,
+        branch: params.branch,
+        commit: params.commit,
+    };
+}
+
+export { normalizeParams };
+//# sourceMappingURL=normalize-params.js.map

package/lib/esm/utils/normalize-params.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalize-params.js","sources":["../../../../src/utils/normalize-params.ts"],"sourcesContent":[null],"names":["LOCALES.AGENT_MISSING_KEY_ERROR","LOCALES.AGENT_MISSING_SLUG_ERROR","LOCALES.AGENT_MISSING_COMMIT_ERROR","LOCALES.AGENT_MISSING_BRANCH_ERROR"],"mappings":";;;;;;;AAYA;;;;;AAKG;AACa,SAAA,eAAe,CAAC,UAAsB,EAAE,MAAoB,EAAA;AAC1E,IAAA,MAAM,OAAO,GAAG,UAAU,EAAE;AAE5B,IAAA,MAAM,MAAM,GAAG;AACb,QAAA,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI;AACrC,QAAA,MAAM,EAAE,UAAU,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;AAC3C,QAAA,EAAE,EAAE,UAAU,CAAC,EAAE,IAAI,OAAO,CAAC,EAAE;AAC/B,QAAA,MAAM,EAAE,UAAU,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM;QAE3C,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,OAAO,EAAE,OAAO,CAAC,OAAO;QAExB,GAAG,EAAE,OAAO,CAAC,GAAG;AAChB,QAAA,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,gBAAgB;AAC9C,QAAA,YAAY,EAAE,eAAa;AAE3B;;;AAGG;QACH,aAAa,EAAE,UAAU,CAAC;AACrB,eAAA,OAAO,CAAC;AACR,gBAAC,MAAM,CAAC,oBAAoB,GAAG,gBAAgB,EAAE,GAAG,SAAS,CAAC;KACpE;AAED,IAAA,KAAK,CAAC,uBAAuB,EAAE,oBAAoB,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;;AAGrE,IAAA,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;AACf,QAAA,MAAM,IAAI,KAAK,CAACA,uBAA+B,CAAC;;AAGlD,IAAA,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;AAChB,QAAA,MAAM,IAAI,KAAK,CAACC,wBAAgC,CAAC;;AAGnD,IAAA,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;AAClB,QAAA,MAAM,IAAI,KAAK,CAACC,0BAAkC,CAAC;;AAGrD,IAAA,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;AAClB,QAAA,MAAM,IAAI,KAAK,CAACC,0BAAkC,CAAC;;;IAIrD,OAAO;AACL,QAAA,GAAG,MAAM;QACT,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB;AACH;;;;"}

package/lib/esm/utils.js

@@ -0,0 +1,9 @@
+export { debug } from './utils/debug.js';
+export { getCommitMessage } from './utils/get-commit-message.js';
+export { getEnvVars } from './utils/get-env-vars.js';
+export { getSlug, getSlugFromGitURL } from './utils/get-slug.js';
+export { logResponse } from './utils/log-response.js';
+export { logger } from './utils/logger.js';
+export { maskObjectProperties } from './utils/mask-object-property.js';
+export { normalizeParams } from './utils/normalize-params.js';
+//# sourceMappingURL=utils.js.map

package/lib/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}

package/lib/types/artifacts/filter-artifacts.d.ts

@@ -0,0 +1,10 @@
+import { type IngestData } from '../constants';
+type Artifact = {
+    key: string;
+    data: unknown;
+};
+/**
+ * Filter artifact data based on the source type and map them by key
+ */
+export declare function filterArtifacts(artifactsData: Array<Artifact>): IngestData;
+export {};

package/lib/types/artifacts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './filter-artifacts';
+export * from './validate-webpack-stats';

package/lib/types/artifacts/validate-webpack-stats.d.ts

@@ -0,0 +1 @@
+export declare function validateWebpackStats(data: any): any;

package/lib/types/constants.d.ts

@@ -0,0 +1,111 @@
+export declare const DEFAULT_ENDPOINT = "https://api.relative-ci.com/save";
+export declare const MASK = "******";
+export declare const SOURCE_WEBPACK_STATS = "webpack.stats";
+export type Source = typeof SOURCE_WEBPACK_STATS;
+export type SourceFilterFn = (data: any) => any;
+export type EnvVars = {
+    /**
+     * true whent it runs in a CI environment
+     */
+    isCi: boolean;
+    /**
+     * RelativeCI project API key
+     */
+    key: string;
+    /**
+     * RelativeCI ingest endpoint
+     */
+    endpoint: string;
+    /**
+     * Project repository slug
+     * @example facebook/react
+     */
+    slug?: string;
+    /**
+     * CI service
+     */
+    service?: string;
+    /**
+     * Branch name
+     */
+    branch?: string;
+    /**
+     * Commit SHA
+     */
+    commit?: string;
+    /**
+     * Pull request number
+     */
+    pr?: string;
+    /**
+     * Build id
+     */
+    build?: string;
+    /**
+     * Build URL
+     */
+    buildUrl?: string;
+    /**
+     * Commit message
+     */
+    commitMessage?: string;
+};
+export type PluginArgs = {
+    slug?: EnvVars['slug'];
+    branch?: EnvVars['slug'];
+    pr?: EnvVars['pr'];
+    commit?: EnvVars['commit'];
+    build?: EnvVars['build'];
+    buildUrl?: EnvVars['buildUrl'];
+    commitMessage?: EnvVars['commitMessage'];
+};
+export type PluginConfig = {
+    /**
+     * Read commit message from the repo
+     * Default: `true`.
+     */
+    includeCommitMessage?: boolean;
+    /**
+     * Absolute path for debug payload filepath
+     * Default: `undefined`.
+     */
+    payloadFilepath?: string;
+};
+export type IngestParams = {
+    key: EnvVars['key'];
+    endpoint: EnvVars['endpoint'];
+    slug: EnvVars['slug'];
+    service?: EnvVars['service'];
+    branch: EnvVars['branch'];
+    commit: EnvVars['commit'];
+    pr?: EnvVars['pr'];
+    build?: EnvVars['build'];
+    buildUrl?: EnvVars['buildUrl'];
+    commitMessage?: EnvVars['commitMessage'];
+    /**
+     * RelativeCI agent version
+     */
+    agentVersion: string;
+};
+export type IngestConfig = {
+    payloadFilepath?: PluginConfig['payloadFilepath'];
+};
+export type IngestData = Record<string, unknown>;
+export type IngestResponseError = {
+    code: string;
+    message: string;
+};
+export type IngestResponseSuccess = {
+    reportUrl?: string;
+    res?: {
+        job?: {
+            internalBuildNumber?: string;
+        };
+    };
+    info?: {
+        message?: {
+            txt?: string;
+        };
+    };
+};
+export type IngestResponse = IngestResponseError & IngestResponseSuccess;

package/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './artifacts';
+export * from './constants';
+export * from './utils';
+export { default as ingest } from './ingest';

package/lib/types/ingest/index.d.ts

@@ -0,0 +1,2 @@
+import ingest from './ingest';
+export default ingest;

package/lib/types/ingest/ingest.d.ts

@@ -0,0 +1,3 @@
+import { type IngestConfig, type IngestData, type IngestParams, type IngestResponseSuccess } from '../constants';
+import { type Logger } from '../utils';
+export default function ingest(data: IngestData, params: IngestParams, config?: IngestConfig, logger?: Logger): Promise<IngestResponseSuccess>;

package/lib/types/ingest/ingest.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/locales/en.d.ts

@@ -0,0 +1,11 @@
+export declare const VALIDATE_ERROR = "Invalid stats structure.";
+export declare const GENERIC_ERROR = "Something went wrong";
+export declare const INGEST_ERROR = "Error ingesting data!";
+export declare const INGEST_INVALID_DATA = "Ingest API responded with invalid data";
+export declare const CLI_MISSING_CONFIGURATION_ERROR = "relativeci.config.js file is missing! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const CLI_INVALID_CONFIGURATION_ERROR = "The path to your webpack stats file is missing! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const CLI_MISSING_STATS_FILE_ERROR = "The webpack stats file does not exists! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const AGENT_MISSING_KEY_ERROR = "\"key\" parameter is missing, make sure to set RELATIVE_CI_KEY environment variable! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const AGENT_MISSING_SLUG_ERROR = "\"slug\" parameter is missing, make sure to set RELATIVE_CI_SLUG environment variable (RELATIVE_CI_SLUG=organization-a/project-a) if you are not using a supported CI service! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const AGENT_MISSING_COMMIT_ERROR = "\"commit\" environment variable is missing, make sure the agent is setup correctly! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";
+export declare const AGENT_MISSING_BRANCH_ERROR = "\"branch\" environment variable is missing, make sure the agent is setup correctly! Read more about RelativeCI agent setup at https://relative-ci.com/documentation/setup.";

package/lib/types/utils/debug.d.ts

@@ -0,0 +1,2 @@
+import getDebug from 'debug';
+export declare const debug: getDebug.Debugger;

package/lib/types/utils/get-commit-message.d.ts

@@ -0,0 +1 @@
+export declare function getCommitMessage(): string;

package/lib/types/utils/get-env-vars.d.ts

@@ -0,0 +1,5 @@
+import { type EnvVars } from '../constants';
+/**
+ * Load environment variables - fallback to env-ci environment variables
+ */
+export declare function getEnvVars(): Partial<EnvVars>;

package/lib/types/utils/get-slug.d.ts

@@ -0,0 +1,9 @@
+import { type CiEnv } from 'env-ci';
+/**
+ * Extract repository slug(owner/repo) from the repo URL
+ */
+export declare function getSlugFromGitURL(repositoryURL?: string): string | undefined;
+/**
+ * Resolve repository slug
+ */
+export declare function getSlug(envVars: CiEnv): string;

package/lib/types/utils/get-slug.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/utils/index.d.ts

@@ -0,0 +1,8 @@
+export * from './debug';
+export * from './get-commit-message';
+export * from './get-env-vars';
+export * from './get-slug';
+export * from './log-response';
+export * from './logger';
+export * from './mask-object-property';
+export * from './normalize-params';

package/lib/types/utils/log-response.d.ts

@@ -0,0 +1,8 @@
+import { type IngestResponseSuccess } from '../constants';
+export declare function logResponse(response: IngestResponseSuccess, logger?: {
+    debug: (message?: any, ...optionalParams: any[]) => void;
+    log: (message?: any, ...optionalParams: any[]) => void;
+    info: (message?: any, ...optionalParams: any[]) => void;
+    warn: (message?: any, ...optionalParams: any[]) => void;
+    error: (message?: any, ...optionalParams: any[]) => void;
+}): void;

package/lib/types/utils/logger.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Basic logger that needs to share the same api
+ * with `console` and plugin loggers(eg: WebpackLogger)
+ */
+export declare const logger: {
+    debug: (message?: any, ...optionalParams: any[]) => void;
+    log: (message?: any, ...optionalParams: any[]) => void;
+    info: (message?: any, ...optionalParams: any[]) => void;
+    warn: (message?: any, ...optionalParams: any[]) => void;
+    error: (message?: any, ...optionalParams: any[]) => void;
+};
+export type Logger = typeof logger;

package/lib/types/utils/mask-object-property.d.ts

@@ -0,0 +1 @@
+export declare function maskObjectProperties(data: Record<string, unknown>, paths: Array<string>): unknown;

package/lib/types/utils/normalize-params.d.ts

@@ -0,0 +1,8 @@
+import { type IngestParams, type PluginArgs, type PluginConfig } from '../constants';
+/**
+ * Normalize ingest params based on:
+ * 1. pluign arguments
+ * 2. computed values
+ * 3. env-ci fallback
+ */
+export declare function normalizeParams(pluginArgs: PluginArgs, config: PluginConfig): IngestParams;

package/package.json

@@ -0,0 +1,91 @@
+{
+  "name": "@relative-ci/core",
+  "version": "5.0.0-alpha.2",
+  "description": "RelativeCI agent core",
+  "keywords": [
+    "webpack",
+    "vitejs",
+    "rspack",
+    "rollup",
+    "bundle-size",
+    "bundle-analyzer",
+    "bundle-stats",
+    "stats",
+    "bundle",
+    "size",
+    "assets",
+    "chunks",
+    "modules"
+  ],
+  "repository": "https://github.com/relative-ci/agent",
+  "bugs": {
+    "url": "https://github.com/relative-ci/agent/issues"
+  },
+  "homepage": "https://relative-ci.com/documentation/setup",
+  "license": "MIT",
+  "author": {
+    "name": "Viorel Cojocaru",
+    "email": "vio@relative-ci.com",
+    "url": "https://relative-ci.com"
+  },
+  "main": "./lib/cjs/index.js",
+  "module": "./lib/esm/index.js",
+  "types": "./lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "require": "./lib/cjs/index.js",
+      "import": "./lib/esm/index.js"
+    },
+    "./artifacts": {
+      "types": "./lib/types/artifacts/index.d.ts",
+      "require": "./lib/cjs/artifacts.js",
+      "import": "./lib/esm/artifacts.js"
+    },
+    "./ingest": {
+      "types": "./lib/types/ingest/index.d.ts",
+      "require": "./lib/cjs/ingest.js",
+      "import": "./lib/esm/ingest.js"
+    },
+    "./utils": {
+      "types": "./lib/types/utils/index.d.ts",
+      "require": "./lib/cjs/utils.js",
+      "import": "./lib/esm/utils.js"
+    },
+    "./locales/en": {
+      "types": "./lib/types/locales/en.d.ts",
+      "require": "./lib/cjs/locales/en.js",
+      "import": "./lib/esm/locales/en.js"
+    }
+  },
+  "scripts": {
+    "build": "npm run clean && rollup -c && npm run build-type",
+    "build-type": "echo '{\"type\":\"commonjs\"}' > lib/cjs/package.json && echo '{\"type\":\"module\"}' > lib/esm/package.json",
+    "clean": "rimraf ./lib",
+    "lint": "eslint .",
+    "test": "vitest src --passWithNoTests --no-watch"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "28.0.3",
+    "@rollup/plugin-node-resolve": "16.0.0",
+    "@rollup/plugin-replace": "6.0.2",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@tsconfig/node18": "^18.2.4",
+    "@types/debug": "4.1.12",
+    "@types/env-ci": "3.1.4",
+    "@types/lodash": "4.17.16",
+    "env-ci": "11.1.0",
+    "rimraf": "6.0.1",
+    "rollup": "4.35.0",
+    "rollup-plugin-node-externals": "8.0.0",
+    "typescript": "5.8.2",
+    "typescript-eslint": "8.26.0",
+    "vitest": "3.0.8"
+  },
+  "dependencies": {
+    "@bundle-stats/plugin-webpack-filter": "4.19.0",
+    "@bundle-stats/plugin-webpack-validate": "4.19.0",
+    "debug": "4.4.0",
+    "lodash": "4.17.21"
+  }
+}

package/typings.d.ts

@@ -0,0 +1,5 @@
+export {}; // make the file a module, to get rid of the warning
+
+declare global {
+  const AGENT_VERSION: string;
+}