Allow use of custom registry

Author: lo1tuma

source/config/registry-settings.test.ts

@@ -2,13 +2,21 @@ import test from 'ava';
 import { checkValidationFailure, checkValidationSuccess } from '../test-libraries/verify-schema-validation.js';
 import { registrySettingsSchema } from './registry-settings.js';
 
-test('validation succeeds when valid registry settings are given', checkValidationSuccess, {
+test('validation succeeds when no url is given', checkValidationSuccess, {
     schema: registrySettingsSchema,
     data: {
         token: 'foo'
     }
 });
 
+test('validation succeeds when url is given', checkValidationSuccess, {
+    schema: registrySettingsSchema,
+    data: {
+        token: 'foo',
+        registryUrl: 'bar'
+    }
+});
+
 test('validation fails when a non-object value is given', checkValidationFailure, {
     schema: registrySettingsSchema,
     data: 'foo',

source/config/registry-settings.ts

@@ -1,7 +1,8 @@
-import { type Schema, struct } from '@effect/schema/Schema';
+import { type Schema, struct, optional } from '@effect/schema/Schema';
 import { type NoExpand, nonEmptyStringSchema } from './base-validations.js';
 
 const $registrySettingsSchema = struct({
+    registryUrl: optional(nonEmptyStringSchema, { exact: true }),
     token: nonEmptyStringSchema
 });
 

source/packages/packtory/packtory.entry-point.ts

@@ -34,3 +34,4 @@ export const { buildAndPublishAll } = packtory;
 export const progressBroadcastConsumer = progressBroadcaster.consumer;
 
 export type { PacktoryConfig } from '../../config/config.js';
+export type { PublishAllResult } from '../../packtory/packtory.js';

source/packtory/packtory.ts

@@ -14,13 +14,14 @@ type ConfigError = {
 };
 
 export type PublishFailure = ConfigError | (PartialError & { type: 'partial' });
+export type PublishAllResult = Result<readonly PublishResult[], PublishFailure>;
 
 export type Packtory = {
     buildAndPublishAll(
         // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents -- we treat the config as unknown but want to provide autocompletion to the client
         config: PacktoryConfig | unknown,
         options: Options
-    ): Promise<Result<readonly PublishResult[], PublishFailure>>;
+    ): Promise<PublishAllResult>;
 };
 
 type PacktoryDependencies = {

source/publisher/registry-client.test.ts

@@ -50,7 +50,25 @@ test('publishPackage() calls npm publish function with the given manifest and ta
     t.deepEqual(publish.firstCall.args, [
         { name: 'the-name', version: 'the-version' },
         tarData,
-        { defaultTag: 'latest', forceAuth: { alwaysAuth: true, token: 'the-token' } }
+        { defaultTag: 'latest', forceAuth: { alwaysAuth: true, token: 'the-token' }, registry: undefined }
+    ]);
+});
+
+test('publishPackage() calls npm publish function with custom registry', async (t) => {
+    const publish = fake.resolves(undefined);
+    const registryClient = registryClientFactory({ publish });
+    const tarData = Buffer.from([1, 2, 3, 4]);
+
+    await registryClient.publishPackage({ name: 'the-name', version: 'the-version' }, tarData, {
+        token: 'the-token',
+        registryUrl: 'the-url'
+    });
+
+    t.is(publish.callCount, 1);
+    t.deepEqual(publish.firstCall.args, [
+        { name: 'the-name', version: 'the-version' },
+        tarData,
+        { defaultTag: 'latest', forceAuth: { alwaysAuth: true, token: 'the-token' }, registry: 'the-url' }
     ]);
 });
 
@@ -69,7 +87,29 @@ test('fetchLatestVersion() fetches the correct package endpoint with the correct
         '/the-name',
         {
             forceAuth: { alwaysAuth: true, token: 'the-token' },
-            headers: { accept: 'application/vnd.npm.install-v1+json' }
+            headers: { accept: 'application/vnd.npm.install-v1+json' },
+            registry: undefined
+        }
+    ]);
+});
+
+test('fetchLatestVersion() fetches the correct package endpoint with the correct authentication settings and headers when using a custom registry', async (t) => {
+    const npmFetchJson = fake.resolves({
+        name: '',
+        'dist-tags': { latest: '1' },
+        versions: { 1: { dist: { shasum: '', tarball: '' } } }
+    });
+    const registryClient = registryClientFactory({ npmFetchJson });
+
+    await registryClient.fetchLatestVersion('the-name', { token: 'the-token', registryUrl: 'the-url' });
+
+    t.is(npmFetchJson.callCount, 1);
+    t.deepEqual(npmFetchJson.firstCall.args, [
+        '/the-name',
+        {
+            forceAuth: { alwaysAuth: true, token: 'the-token' },
+            headers: { accept: 'application/vnd.npm.install-v1+json' },
+            registry: 'the-url'
         }
     ]);
 });

source/publisher/registry-client.ts

@@ -74,6 +74,7 @@ export function createRegistryClient(dependencies: Readonly<RegistryClientDepend
                 alwaysAuth: true,
                 token: registrySettings.token
             },
+            registry: registrySettings.registryUrl,
             headers: { accept: acceptHeaderForFetchingAbbreviatedResponse }
         });
     }
@@ -113,7 +114,8 @@ export function createRegistryClient(dependencies: Readonly<RegistryClientDepend
                 forceAuth: {
                     alwaysAuth: true,
                     token: registrySettings.token
-                }
+                },
+                registry: registrySettings.registryUrl
             });
         },