@perforce-perfecto/scriptless-helpers-types 0.0.2

package/CLAUDE.md

@@ -0,0 +1,50 @@
+# shared-types-public
+
+Published to npm as `@perforce-perfecto/scriptless-helpers-types` (`scope:public`). This package is consumed by external users — everything in it is fully public.
+
+## What belongs here
+
+Shared TypeScript types, interfaces, and enums that must be understood by both internal services and external consumers of the public npm package. Examples: execution DTOs, device capability types, data-table structures.
+
+## Rules
+
+### No sensitive or proprietary content
+Never add to this lib:
+- Internal URLs, hostnames, environment variables, or infrastructure details
+- Credentials, tokens, API keys, or secrets of any kind
+- Business logic, algorithms, or implementation details that are proprietary
+- Internal Perfecto/Perforce system identifiers or configurations
+- Types that expose internal service architecture (e.g. RabbitMQ queue names, S3 bucket shapes, K8s job specs)
+
+Only pure type definitions and enums with no runtime logic that reveals internal systems.
+
+### Allowed imports only
+This lib has `scope:public` tag. It may only import from other `scope:public` libs.
+
+**Allowed:**
+- `tslib`
+- Other `@perforce-perfecto/*` public npm packages
+- Standard TypeScript/Node built-in types
+
+**Forbidden:**
+- `@perfectomobiledev/*` — these are internal private packages and must never be imported here
+- Any `scope:private` lib from this monorepo
+- Internal service clients or infrastructure SDKs (AWS, K8s, RabbitMQ, etc.)
+
+Nx enforces this via `@nx/enforce-module-boundaries` — a lint error will surface any violation.
+
+### PRs touching this lib
+All PRs require a review confirming no proprietary logic, internal URLs, credentials, or internal infrastructure details are exposed.
+
+## Build & publish
+
+```bash
+# Build
+npx nx build shared-types-public
+
+# Publish (from dist)
+cd dist/libs/shared-types-public
+npm publish --access public
+```
+
+The `.npmignore` in this directory excludes `*.js.map` files from the published package.

package/README.md

@@ -0,0 +1,5 @@
+# @perforce-perfecto/scriptless-helpers-types
+
+Shared TypeScript types and interfaces for Perfecto Scriptless execution helpers.
+
+Published as `@perforce-perfecto/scriptless-helpers-types`.

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@perforce-perfecto/scriptless-helpers-types",
+  "version": "0.0.2",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,11 @@
+export * from './lib/active-script-function-data';
+export * from './lib/scriptless-helper';
+export * from './lib/logger';
+export * from './lib/data-table';
+export * from './lib/type-utils';
+export * from './lib/user-defined-variables';
+export * from './lib/desired-device-capabilities';
+export * from './lib/perfecto-device-capabilities';
+export * from './lib/loop-iteration-state';
+export * from './lib/file-transfer';
+export * from './lib/execution-cache';

package/src/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/active-script-function-data"), exports);
+tslib_1.__exportStar(require("./lib/scriptless-helper"), exports);
+tslib_1.__exportStar(require("./lib/logger"), exports);
+tslib_1.__exportStar(require("./lib/data-table"), exports);
+tslib_1.__exportStar(require("./lib/type-utils"), exports);
+tslib_1.__exportStar(require("./lib/user-defined-variables"), exports);
+tslib_1.__exportStar(require("./lib/desired-device-capabilities"), exports);
+tslib_1.__exportStar(require("./lib/perfecto-device-capabilities"), exports);
+tslib_1.__exportStar(require("./lib/loop-iteration-state"), exports);
+tslib_1.__exportStar(require("./lib/file-transfer"), exports);
+tslib_1.__exportStar(require("./lib/execution-cache"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/active-script-function-data.d.ts

@@ -0,0 +1,12 @@
+export type ActiveScriptFunctionData = {
+    commandStartTime: number;
+    actionResult: string | boolean | undefined;
+    actionError?: Error;
+    errorType: string;
+    screenshotData?: unknown[];
+    reportResultData: unknown[];
+    reportExpectedData: unknown[];
+    reportExpectedImage: unknown[];
+    actionReportMessage: string;
+    reportUxTime: string;
+};

package/src/lib/active-script-function-data.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=active-script-function-data.js.map

package/src/lib/data-table.d.ts

@@ -0,0 +1,30 @@
+import { type DesiredDeviceCapability } from './desired-device-capabilities';
+import { type Replace } from './type-utils';
+type DataType = 'BOOLEAN' | 'INTEGER' | 'STRING' | 'HANDSET' | 'TABLE' | 'MULTIMEDIA' | 'PROPERTY' | 'OBJECT';
+export type ServerDataTableDataType = Exclude<Exclude<DataType, 'TABLE'>, 'PROPERTY'>;
+export type DataTableDataType = ServerDataTableDataType;
+export type ServerTableColumn = {
+    name: string;
+    type: ServerDataTableDataType;
+};
+export type TableColumn = ServerTableColumn & {
+    duplicateName: boolean;
+};
+export type DataTableCellValue = string;
+export type DataTableRow = DataTableCellValue[];
+export type ServerDataTable = {
+    elementsData: DataTableRow[];
+    columns: ServerTableColumn[];
+};
+export type DataTable = Replace<ServerDataTable, 'columns', TableColumn[]>;
+export type ProcessedDataTableCell = {
+    '@type': ServerDataTableDataType;
+    secured: boolean;
+    value?: string | number | boolean;
+    key?: string | DesiredDeviceCapability | null;
+};
+export type ProcessedDataTableRow = {
+    [key: string]: ProcessedDataTableCell;
+};
+export type ProcessedDataTable = Array<ProcessedDataTableRow>;
+export {};

package/src/lib/data-table.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data-table.js.map

package/src/lib/desired-device-capabilities.d.ts

@@ -0,0 +1,29 @@
+type SharedDesiredDeviceCapability = {
+    deviceSessionId?: string;
+    deviceId?: string;
+    tunnelId?: string;
+};
+export type DesiredWebDeviceCapability = {
+    platformName: string;
+    platformVersion: string;
+    browserName: string;
+    browserVersion: string;
+    location: string;
+    resolution: string;
+} & SharedDesiredDeviceCapability;
+export type DesiredVirtualDeviceCapability = {
+    platformName: string;
+    platformVersion: string;
+    manufacturer: string;
+    model: string;
+    useVirtualDevice: boolean;
+} & SharedDesiredDeviceCapability;
+export type DesiredDesktopDeviceCapability = {
+    deviceName: string;
+    deviceType: 'desktop_app';
+} & SharedDesiredDeviceCapability;
+export type DesiredRealDeviceCapability = {
+    deviceName: string;
+} & SharedDesiredDeviceCapability;
+export type DesiredDeviceCapability = DesiredWebDeviceCapability | DesiredVirtualDeviceCapability | DesiredRealDeviceCapability | DesiredDesktopDeviceCapability;
+export {};

package/src/lib/desired-device-capabilities.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=desired-device-capabilities.js.map

package/src/lib/execution-cache.d.ts

@@ -0,0 +1,6 @@
+export declare enum ExecutionCacheItemStatus {
+    Initializing = "Initializing",
+    Running = "Running",
+    Terminating = "Terminating",
+    Completed = "Completed"
+}

package/src/lib/execution-cache.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExecutionCacheItemStatus = void 0;
+var ExecutionCacheItemStatus;
+(function (ExecutionCacheItemStatus) {
+    /*
+     * ExecutionCacheItemStatus values and their usage:
+     * Initializing - when the execution is created, i.e. before creating the execution container in ExecutionsService
+     * Running - upon receiving the ExecutionStartEvent in ReportingEventsService
+     * Terminating - when the execution is cancelled in ExecutionsService
+     * Completed - upon receiving the ExecutionProgressEndEvent in ProgressEventsService
+     */
+    ExecutionCacheItemStatus["Initializing"] = "Initializing";
+    ExecutionCacheItemStatus["Running"] = "Running";
+    ExecutionCacheItemStatus["Terminating"] = "Terminating";
+    ExecutionCacheItemStatus["Completed"] = "Completed";
+})(ExecutionCacheItemStatus || (exports.ExecutionCacheItemStatus = ExecutionCacheItemStatus = {}));
+//# sourceMappingURL=execution-cache.js.map

package/src/lib/file-transfer.d.ts

@@ -0,0 +1,24 @@
+export type RepositoryArtifactUploadParams = {
+    contentType: string;
+    artifactType: string;
+    folderType: string;
+    keyDetails: {
+        version: string;
+        artifactId: string;
+    };
+    override: boolean;
+    userMetadata: {
+        tags: string[];
+    };
+    hidden: boolean;
+    temporary: boolean;
+    fileName: string;
+};
+export declare enum RepositoryArtifactType {
+    MEDIA = "MEDIA"
+}
+export type RepositoryArtifactDownloadParams = {
+    artifactId: string;
+    folderType: string;
+    repositoryType: RepositoryArtifactType;
+};

package/src/lib/file-transfer.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RepositoryArtifactType = void 0;
+var RepositoryArtifactType;
+(function (RepositoryArtifactType) {
+    RepositoryArtifactType["MEDIA"] = "MEDIA";
+})(RepositoryArtifactType || (exports.RepositoryArtifactType = RepositoryArtifactType = {}));
+//# sourceMappingURL=file-transfer.js.map

package/src/lib/logger.d.ts

@@ -0,0 +1,8 @@
+export interface Logger {
+    log(message: unknown, ...optionalParams: unknown[]): void;
+    info(message: unknown, ...optionalParams: unknown[]): void;
+    warn(message: unknown, ...optionalParams: unknown[]): void;
+    debug(message: unknown, ...optionalParams: unknown[]): void;
+    profile(id: string, ...optionalParams: unknown[]): void;
+    error(message: unknown, errorData?: unknown): void;
+}

package/src/lib/logger.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=logger.js.map

package/src/lib/loop-iteration-state.d.ts

@@ -0,0 +1,4 @@
+export type LoopIterationState = {
+    identifier: string;
+    iteration: number;
+};

package/src/lib/loop-iteration-state.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=loop-iteration-state.js.map

package/src/lib/perfecto-device-capabilities.d.ts

@@ -0,0 +1,127 @@
+type JsonString = string;
+type UrlString = string;
+type PerfectoDeviceCapabilityBase = {
+    webStorageEnabled: boolean;
+    locationContextEnabled: boolean;
+    browserName: string;
+    platform: JsonString;
+    javascriptEnabled: boolean;
+    databaseEnabled: boolean;
+    takesScreenshot: boolean;
+    networkConnectionEnabled: boolean;
+    platformName: string;
+    deviceName: string;
+    platformVersion: string;
+    stopUrl: UrlString;
+    streamInfo: JsonString;
+    userContextStack: JsonString;
+    securityToken: string;
+    sessionType: string;
+    testGridReportUrl: UrlString;
+    reportPdfUrl: UrlString;
+    executionId: string;
+    deviceSessionId: string;
+};
+export type PerfectoRealDeviceCapabilityOptions = {
+    deviceName: string;
+    securityToken: string;
+    'report.parentExecutionId': string;
+    sessionType: string;
+    cloud: string;
+    userContextStack: JsonString;
+};
+export type PerfectoRealDeviceCapability = PerfectoDeviceCapabilityBase & {
+    automationName: string;
+    xcuitestFindOptimizations: boolean;
+    udid: string;
+    simpleIsVisibleCheck: boolean;
+    bundleId: string;
+    assert_javascript_enabled: boolean;
+    audioStreamInfo: JsonString;
+    entityType: string;
+    host: string;
+    internalPureAppiumFlow: boolean;
+    options: PerfectoRealDeviceCapabilityOptions;
+    password: string;
+    scriptName: string;
+    securePureAppiumFlow: boolean;
+    serverConnector: string;
+    testRunWithPureAppiumFlow: boolean;
+    mcmExecutionId: string;
+};
+export type PerfectoVirtualDeviceCapabilityOptions = {
+    platformName: string;
+    manufacturer?: string;
+    model?: string;
+    platformVersion?: string;
+    useVirtualDevice?: boolean;
+    securityToken: string;
+    'report.parentExecutionId': string;
+    sessionType: string;
+    cloud: string;
+    userContextStack: JsonString;
+};
+export type PerfectoVirtualDeviceCapability = PerfectoDeviceCapabilityBase & {
+    mjpegServerPort: number;
+    simulatorStartupTimeout: number;
+    automationName: string;
+    udid: string;
+    usePrebuiltWDA: boolean;
+    'appium:mjpegServerPort': string;
+    'appium:simulatorStartupTimeout': number;
+    'appium:automationName': string;
+    'appium:platformVersion': string;
+    manufacturer: string;
+    'appium:udid': string;
+    'perfecto:options': PerfectoVirtualDeviceCapabilityOptions;
+    model: string;
+    'appium:deviceName': string;
+    useVirtualDevice: boolean;
+    'appium:usePrebuiltWDA': boolean;
+};
+export type PerfectoWebDeviceCapabilityChrome = {
+    chromedriverVersion: string;
+    userDataDir: string;
+};
+export type PerfectoWebDeviceCapabilityTimeouts = {
+    implicit: number;
+    pageLoad: number;
+    script: number;
+};
+export type PerfectoWebDeviceCapability = {
+    acceptInsecureCerts: boolean;
+    browserName: string;
+    browserVersion: string;
+    chrome: PerfectoWebDeviceCapabilityChrome;
+    'fedcm:accounts': boolean;
+    'goog:chromeOptions': {
+        debuggerAddress: string;
+    };
+    'goog:processID': number;
+    networkConnectionEnabled: boolean;
+    pageLoadStrategy: string;
+    platformName: string;
+    proxy: Record<string, unknown>;
+    'se:bidiEnabled': boolean;
+    setWindowRect: boolean;
+    strictFileInteractability: boolean;
+    timeouts: PerfectoWebDeviceCapabilityTimeouts;
+    unhandledPromptBehavior: string;
+    'webauthn:extension:credBlob': boolean;
+    'webauthn:extension:largeBlob': boolean;
+    'webauthn:extension:minPinLength': boolean;
+    'webauthn:extension:prf': boolean;
+    'webauthn:virtualAuthenticators': boolean;
+    stopUrl: UrlString;
+    platformVersion: string;
+    streamInfo: JsonString;
+    location: string;
+    resolution: string;
+    testGridReportUrl: UrlString;
+    reportPdfUrl: UrlString;
+    executionId: string;
+    platform: JsonString;
+    deviceSessionId: string;
+};
+export type PerfectoDeviceCapability = PerfectoRealDeviceCapability | PerfectoVirtualDeviceCapability | PerfectoWebDeviceCapability;
+export {};

package/src/lib/perfecto-device-capabilities.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=perfecto-device-capabilities.js.map

package/src/lib/scriptless-helper.d.ts

@@ -0,0 +1,5 @@
+import { Logger } from './logger';
+export declare abstract class ScriptlessHelper {
+    protected logger: Logger;
+    constructor(logger?: Logger);
+}

package/src/lib/scriptless-helper.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScriptlessHelper = void 0;
+class ScriptlessHelper {
+    constructor(logger) {
+        this.logger = logger || console;
+    }
+}
+exports.ScriptlessHelper = ScriptlessHelper;
+//# sourceMappingURL=scriptless-helper.js.map

package/src/lib/type-utils.d.ts

@@ -0,0 +1,3 @@
+export type Replace<T, K extends keyof T, NEW> = Omit<T, K> & {
+    [key in K]: NEW;
+};

package/src/lib/type-utils.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=type-utils.js.map

package/src/lib/user-defined-variables.d.ts

@@ -0,0 +1,11 @@
+import { DesiredDeviceCapability } from './desired-device-capabilities';
+export type VariableDataType = 'BooleanData' | 'HandsetData' | 'IntegerData' | 'MediaData' | 'StringData' | 'TableData' | 'UrlData';
+export type UserDefinedVariables = {
+    [variableName: string]: UserDefinedVariable;
+};
+export type UserDefinedVariable = {
+    value: string;
+    secured: boolean;
+    '@type': VariableDataType;
+    key?: DesiredDeviceCapability;
+};

package/src/lib/user-defined-variables.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user-defined-variables.js.map