@forge/cli-shared 8.23.0-next.8-experimental-2e302e1 → 8.23.0

package/out/shared/forge-cli-attribution.d.ts

@@ -1,6 +1,16 @@
 export declare class ForgeCliAttribution {
     static isAgent(): boolean;
     static isCI(): boolean;
-    static build(): Record<string, unknown>;
+    static skillName(): string;
+    static agentHint(): Promise<string>;
+    static isStudio(): boolean;
+    static build(): Promise<Record<string, unknown>>;
+    private static getWildcardAttribution;
+    private static getValidAttributionEnvValue;
+    private static isValidAttributionValue;
+    private static isValidWildcardKey;
+    private static hasEnvKeySet;
+    private static camelCaseEnvKey;
+    private static capitalize;
 }
 //# sourceMappingURL=forge-cli-attribution.d.ts.map

package/out/shared/forge-cli-attribution.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"forge-cli-attribution.d.ts","sourceRoot":"","sources":["../../src/shared/forge-cli-attribution.ts"],"names":[],"mappings":"AAiBA,qBAAa,mBAAmB;WAOhB,OAAO,IAAI,OAAO;WAQlB,IAAI,IAAI,OAAO;WAWf,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAM/C"}
+{"version":3,"file":"forge-cli-attribution.d.ts","sourceRoot":"","sources":["../../src/shared/forge-cli-attribution.ts"],"names":[],"mappings":"AA0CA,qBAAa,mBAAmB;WAOhB,OAAO,IAAI,OAAO;WAQlB,IAAI,IAAI,OAAO;WAIf,SAAS,IAAI,MAAM;WAIb,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;WAuBlC,QAAQ,IAAI,OAAO;WAWb,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAW7D,OAAO,CAAC,MAAM,CAAC,sBAAsB;IAgDrC,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAK1C,OAAO,CAAC,MAAM,CAAC,uBAAuB;IAStC,OAAO,CAAC,MAAM,CAAC,kBAAkB;IAIjC,OAAO,CAAC,MAAM,CAAC,YAAY;IAK3B,OAAO,CAAC,MAAM,CAAC,eAAe;IAS9B,OAAO,CAAC,MAAM,CAAC,UAAU;CAG1B"}

package/out/shared/forge-cli-attribution.js

@@ -1,6 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ForgeCliAttribution = void 0;
+const detect_agent_1 = require("@vercel/detect-agent");
+const ATL_FORGE_ATTRIBUTION_ENV_PREFIX = 'ATL_FORGE_ATTRIBUTION_';
+const UNKNOWN = 'unknown';
+const MAX_ATTRIBUTION_VALUE_LENGTH = 512;
+const MAX_WILDCARD_PAYLOAD_BYTES = 4096;
+const MAX_WILDCARD_FIELDS = 32;
+const ATTRIBUTION_VALUE_PATTERN = /^[A-Za-z0-9._\-/:+]+$/;
+const WILDCARD_KEY_PATTERN = /^[A-Za-z][A-Za-z0-9_]*$/;
+const WELL_KNOWN_ATTRIBUTION_ENV_KEYS = new Set(['AGENT_HINT', 'IS_STUDIO', 'SKILL_NAME']);
+const RESERVED_ATTRIBUTION_FIELDS = new Set([
+    'agentHint',
+    'businessUnit',
+    'isAgent',
+    'isCI',
+    'isStudio',
+    'service',
+    'skillName'
+]);
 class ForgeCliAttribution {
     static isAgent() {
         return !process.stdin.isTTY && !process.stdout.isTTY;
@@ -8,11 +26,104 @@ class ForgeCliAttribution {
     static isCI() {
         return process.env.CI === 'true';
     }
-    static build() {
+    static skillName() {
+        return this.getValidAttributionEnvValue('SKILL_NAME') || UNKNOWN;
+    }
+    static async agentHint() {
+        const explicitAgentHint = this.getValidAttributionEnvValue('AGENT_HINT');
+        if (explicitAgentHint) {
+            return explicitAgentHint;
+        }
+        if (this.hasEnvKeySet('ROVODEV_CLI')) {
+            return 'rovo-dev';
+        }
+        if (this.hasEnvKeySet('WINDSURF_CASCADE_TERMINAL_KIND')) {
+            return 'windsurf';
+        }
+        try {
+            const result = await (0, detect_agent_1.determineAgent)();
+            if (result?.isAgent && typeof result.agent?.name === 'string' && result.agent.name) {
+                return result.agent.name;
+            }
+        }
+        catch {
+        }
+        return UNKNOWN;
+    }
+    static isStudio() {
+        return this.getValidAttributionEnvValue('IS_STUDIO') === 'true';
+    }
+    static async build() {
         return {
             isAgent: this.isAgent(),
-            isCI: this.isCI()
+            isCI: this.isCI(),
+            skillName: this.skillName(),
+            agentHint: await this.agentHint(),
+            isStudio: this.isStudio(),
+            ...this.getWildcardAttribution()
         };
     }
+    static getWildcardAttribution() {
+        const wildcardAttribution = {};
+        let totalBytes = 0;
+        const sortedEntries = Object.entries(process.env).sort(([a], [b]) => a.localeCompare(b));
+        for (const [envKey, envValue] of sortedEntries) {
+            if (!envKey.startsWith(ATL_FORGE_ATTRIBUTION_ENV_PREFIX)) {
+                continue;
+            }
+            const attributionEnvKey = envKey.slice(ATL_FORGE_ATTRIBUTION_ENV_PREFIX.length);
+            if (WELL_KNOWN_ATTRIBUTION_ENV_KEYS.has(attributionEnvKey)) {
+                continue;
+            }
+            if (!this.isValidWildcardKey(attributionEnvKey) || !this.isValidAttributionValue(envValue)) {
+                continue;
+            }
+            const attributionKey = this.camelCaseEnvKey(attributionEnvKey);
+            if (!attributionKey || RESERVED_ATTRIBUTION_FIELDS.has(attributionKey)) {
+                continue;
+            }
+            if (attributionKey in wildcardAttribution) {
+                continue;
+            }
+            if (Object.keys(wildcardAttribution).length >= MAX_WILDCARD_FIELDS) {
+                break;
+            }
+            const fieldBytes = attributionKey.length + envValue.length + 4;
+            if (totalBytes + fieldBytes > MAX_WILDCARD_PAYLOAD_BYTES) {
+                continue;
+            }
+            wildcardAttribution[attributionKey] = envValue;
+            totalBytes += fieldBytes;
+        }
+        return wildcardAttribution;
+    }
+    static getValidAttributionEnvValue(key) {
+        const value = process.env[`${ATL_FORGE_ATTRIBUTION_ENV_PREFIX}${key}`];
+        return this.isValidAttributionValue(value) ? value : undefined;
+    }
+    static isValidAttributionValue(value) {
+        return (typeof value === 'string' &&
+            value.length > 0 &&
+            value.length <= MAX_ATTRIBUTION_VALUE_LENGTH &&
+            ATTRIBUTION_VALUE_PATTERN.test(value));
+    }
+    static isValidWildcardKey(key) {
+        return WILDCARD_KEY_PATTERN.test(key);
+    }
+    static hasEnvKeySet(key) {
+        const value = process.env[key];
+        return value !== undefined && value !== '';
+    }
+    static camelCaseEnvKey(key) {
+        return key
+            .toLowerCase()
+            .split('_')
+            .filter(Boolean)
+            .map((part, index) => (index === 0 ? part : this.capitalize(part)))
+            .join('');
+    }
+    static capitalize(value) {
+        return `${value.charAt(0).toUpperCase()}${value.slice(1)}`;
+    }
 }
 exports.ForgeCliAttribution = ForgeCliAttribution;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/cli-shared",
-  "version": "8.23.0-next.8-experimental-2e302e1",
+  "version": "8.23.0",
   "description": "Common functionality for Forge CLI",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -12,10 +12,11 @@
     "generate-graphql-types": "graphql-codegen --config src/graphql/codegen.yml"
   },
   "dependencies": {
-    "@forge/manifest": "12.8.0-next.7-experimental-2e302e1",
+    "@forge/manifest": "12.8.0",
     "@forge/util": "2.0.1",
     "@forge/i18n": "0.0.7",
     "@sentry/node": "7.106.0",
+    "@vercel/detect-agent": "^1.2.3",
     "adm-zip": "^0.5.10",
     "array.prototype.flatmap": "^1.3.3",
     "case": "^1.6.3",
@@ -47,6 +48,7 @@
   },
   "devDependencies": {
     "@atlassian/xen-test-util": "^4.2.0",
+    "@colors/colors": "1.5.0",
     "@graphql-codegen/add": "^5.0.2",
     "@graphql-codegen/cli": "^5.0.2",
     "@graphql-codegen/typescript": "^4.1.6",