ado-npm-auth 0.2.0 → 0.3.0

package/lib/ado/make-ado-request.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Check if the user is authenticated to the ADO API.
+ * This function performs a network request to retrieve an ADO feed for the given organization
+ * Since that request is usually slow, and we don't actually know the ID of a valid feed, we just use the "invalid" ID of "1"
+ * If the network request returns 401, then the PAT is invalid. If the request returns 404 (or somehow 200) then the PAT is valid
+ * @param {Object} options
+ * @param {string} options.password The password to use for the login
+ * @param {string} options.organization The organization to check against
+ * @returns
+ */
+export declare const makeADORequest: ({ password, organization, }: {
+    password: string;
+    organization: string;
+}) => Promise<void>;
+//# sourceMappingURL=make-ado-request.d.ts.map

package/lib/azureauth/ado.d.ts

@@ -0,0 +1,26 @@
+export type AdoPatOptions = {
+    promptHint: string;
+    organization: string;
+    displayName: string;
+    scope: string[];
+    output?: string;
+    mode?: string;
+    domain?: string;
+    timeout?: string;
+};
+export type AdoPatResponse = {
+    displayName: string;
+    validTo: string;
+    scope: string[];
+    targetAccounts: string[];
+    validFrom: string;
+    authorizationId: string;
+    token: string;
+};
+/**
+ * Wrapper for `azureauth ado pat`. Please run `azureauth ado pat --help` for full command options and description
+ * @param options Options for PAT generation
+ * @returns ADO PAT details
+ */
+export declare const adoPat: (options: AdoPatOptions, azureAuthLocation?: string) => Promise<AdoPatResponse | string>;
+//# sourceMappingURL=ado.d.ts.map

package/lib/azureauth/ado.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ado.test.d.ts.map

package/lib/azureauth/azureauth-command.d.ts

@@ -0,0 +1,11 @@
+export declare const clearMemo: () => void;
+/**
+ * Get the executable path of azureauth command
+ * @returns the string of the executable command to run azureauth, and any
+ * necessary environment variables if using npx
+ */
+export declare const azureAuthCommand: () => {
+    command: string[];
+    env: Record<string, string>;
+};
+//# sourceMappingURL=azureauth-command.d.ts.map

package/lib/azureauth/index.d.ts

@@ -0,0 +1,2 @@
+export { adoPat } from "./ado.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/azureauth/is-azureauth-installed.d.ts

@@ -0,0 +1,7 @@
+export declare const clearMemo: () => void;
+/**
+ * Determine if a valid version (>=0.8.0.0) is installed
+ * @returns { boolean } Whether a valid version of azureauth is installed
+ */
+export declare const isAzureAuthInstalled: () => Promise<boolean>;
+//# sourceMappingURL=is-azureauth-installed.d.ts.map

package/lib/azureauth/is-azureauth-installed.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=is-azureauth-installed.test.d.ts.map

package/lib/azureauth/is-supported-platform-and-architecture.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determines if the currently running platform is supported by azureauth. Currently, supported platforms are Windows, Mac & WSL
+ * @returns { boolean } if the current platform is supported by azureauth
+ */
+export declare const isSupportedPlatformAndArchitecture: () => boolean;
+//# sourceMappingURL=is-supported-platform-and-architecture.d.ts.map

package/lib/npmrc/generate-npmrc-pat.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Generates a valid ADO PAT, scoped for vso.packaging in the given ado organization, 30 minute timeout
+ * @returns { string } a valid ADO PAT
+ */
+export declare const generateNpmrcPat: (organization: string, encode?: boolean, azureAuthLocation?: string) => Promise<string>;
+//# sourceMappingURL=generate-npmrc-pat.d.ts.map

package/lib/npmrc/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/lib/npmrc/npmrcFileProvider.d.ts

@@ -0,0 +1,12 @@
+import { Feed, FileProvider } from "../fileProvider.js";
+export declare class NpmrcFileProvider extends FileProvider {
+    constructor(configFile?: string);
+    prepUserFile(): Promise<void>;
+    getWorkspaceRegistries(): Promise<string[]>;
+    getUserFeeds(): Promise<Map<string, Feed>>;
+    patchUserNpmRcFile(newLinesByRegistryAndField: Map<string, string>): Promise<string[]>;
+    toRegistryAndFunctionKey(registry: string, field: string): string;
+    writeWorkspaceRegistries(feedsToPatch: Iterable<Feed>): Promise<void>;
+    processNpmRcFile(npmrcFilePath: string, handleFeedConfig: (line: string, registry: string, field: string, value: string) => string | void, handleOtherLine?: (line: string) => string | void): Promise<string[]>;
+}
+//# sourceMappingURL=npmrcFileProvider.d.ts.map

package/lib/telemetry/index.d.ts

@@ -0,0 +1,20 @@
+export type TelemetryProperties = {
+    success: boolean;
+    automaticSuccess: boolean;
+    platform: string;
+    arch: string;
+    error: string;
+};
+export interface TelemetryClient {
+    LogEvent: (eventName: string, properties: Map<string, string>) => void;
+    flush(): void;
+}
+/**
+ * Logs an node-azure-auth event to telemetry.
+ */
+export declare const logTelemetry: (inputProperties: {
+    success?: boolean;
+    automaticSuccess?: boolean;
+    error?: string;
+}, flush?: boolean, client?: TelemetryClient) => void;
+//# sourceMappingURL=index.d.ts.map

package/lib/utils/encoding.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Create a base64 encoded string from a string
+ * @param {string} input
+ * @returns {string}
+ */
+export declare function toBase64(input: string | undefined): string;
+/**
+ * Decode a base64 encoded string
+ * @param {string} base64string
+ * @returns
+ */
+export declare const fromBase64: (base64string: string) => string;
+//# sourceMappingURL=encoding.d.ts.map

package/lib/utils/exec.d.ts

@@ -0,0 +1,3 @@
+import { exec as _exec } from "node:child_process";
+export declare const exec: typeof _exec.__promisify__;
+//# sourceMappingURL=exec.d.ts.map

package/lib/utils/get-feed-without-protocol.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Given the feed url, get the name of the feed without the protocol ("https") at the beginning
+ */
+export declare const getFeedWithoutProtocol: (feed: string) => string;
+//# sourceMappingURL=get-feed-without-protocol.d.ts.map

package/lib/utils/get-feed-without-protocol.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-feed-without-protocol.test.d.ts.map

package/lib/utils/get-organization-from-feed-url.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get the ADO Org for a npm feed
+ * @param {string} feedUrl URL of the feed to get the ADO organization from
+ * @param {string} [defaultOrg] Backup org in case it cannot be determined from the feed url
+ * @returns ADO Organization for the feed
+ */
+export declare const getOrganizationFromFeedUrl: (feedUrl: string, defaultOrg?: string) => string;
+//# sourceMappingURL=get-organization-from-feed-url.d.ts.map

package/lib/utils/get-organization-from-feed-url.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-organization-from-feed-url.test.d.ts.map

package/lib/utils/is-codespaces.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determines if the current machine's setup is codespaces
+ * @returns { boolean } if the current machine is in codespaces
+ */
+export declare const isCodespaces: () => boolean;
+//# sourceMappingURL=is-codespaces.d.ts.map

package/lib/utils/is-wsl.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Determine if the current machine's platform is WSL
+ * @returns { boolean } if the current platform is WSL
+ */
+export declare const isWsl: () => boolean;
+//# sourceMappingURL=is-wsl.d.ts.map

package/lib/utils/partition.d.ts

@@ -0,0 +1,2 @@
+export declare function partition<TValue, TKey>(items: TValue[], keySelector: (item: TValue) => TKey): Map<TKey, TValue[]>;
+//# sourceMappingURL=partition.d.ts.map

package/lib/utils/request.d.ts

@@ -0,0 +1,8 @@
+import { RequestOptions } from "https";
+/**
+ *
+ * @param {import("http").RequestOptions} options
+ * @returns
+ */
+export declare const makeRequest: (options: RequestOptions) => Promise<unknown>;
+//# sourceMappingURL=request.d.ts.map

package/lib/yarnrc/yarnrcFileProvider.d.ts

@@ -0,0 +1,29 @@
+import { Feed, FileProvider } from "../fileProvider.js";
+export declare class YarnRcFileProvider extends FileProvider {
+    constructor(configFile?: string);
+    prepUserFile(): Promise<void>;
+    getUserFeeds(): Promise<Map<string, Feed>>;
+    getWorkspaceRegistries(): Promise<string[]>;
+    writeWorkspaceRegistries(feedsToPatch: Iterable<Feed>): Promise<void>;
+    paseYarnRc(filePath: string): Promise<YarnRc>;
+}
+interface YarnRc {
+    npmRegistryServer?: string;
+    npmScopes?: {
+        [org: string]: {
+            npmRegistryServer?: string;
+            npmAlwaysAuth?: boolean;
+            npmAuthIdent?: string;
+            npmAuthToken?: string;
+        };
+    };
+    npmRegistries?: {
+        [registry: string]: {
+            npmAlwaysAuth?: boolean;
+            npmAuthIdent?: string;
+            npmAuthToken?: string;
+        };
+    };
+}
+export {};
+//# sourceMappingURL=yarnrcFileProvider.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ado-npm-auth",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The ado-npm-auth package can automatically use the azureauth CLI to fetch tokens and update a user's .npmrc file for authenticating to ADO package feeds.",
   "repository": "https://github.com/microsoft/ado-npm-auth",
   "license": "MIT",
@@ -13,7 +13,7 @@
   "files": [
     "dist/index.js",
     "dist/ado-npm-auth.cjs",
-    "lib/*.d.ts",
+    "lib/**/*.d.ts",
     "bin",
     "static",
     "LICENCSE.txt",