Cleaned up custom-redirects types.ts

ghost/core/core/server/adapters/redirects/FileStore.ts

@@ -4,7 +4,8 @@ import path from 'path';
 import RedirectsStoreBase from './RedirectsStoreBase';
 import {parseJson, parseYaml} from '../../services/custom-redirects/redirect-config-parser';
 import {getBackupRedirectsFilePath} from '../../services/custom-redirects/utils';
-import type {RedirectConfig, RedirectsStore} from '../../services/custom-redirects/types';
+import type {RedirectConfig} from '../../services/custom-redirects/redirect-config';
+import type {RedirectsStore} from '../../services/custom-redirects/redirects-service';
 
 const YAML_FILENAME = 'redirects.yaml';
 const JSON_FILENAME = 'redirects.json';

ghost/core/core/server/adapters/redirects/S3RedirectsStore.ts

@@ -14,7 +14,8 @@ import * as errors from '@tryghost/errors';
 import RedirectsStoreBase from './RedirectsStoreBase';
 import {parseJson} from '../../services/custom-redirects/redirect-config-parser';
 import {getBackupRedirectsFilePath} from '../../services/custom-redirects/utils';
-import type {RedirectConfig, RedirectsStore} from '../../services/custom-redirects/types';
+import type {RedirectConfig} from '../../services/custom-redirects/redirect-config';
+import type {RedirectsStore} from '../../services/custom-redirects/redirects-service';
 
 const DEFAULT_FILENAME = 'redirects.json';
 

ghost/core/core/server/services/custom-redirects/redirect-config-parser.ts

@@ -2,7 +2,7 @@ import yaml from 'js-yaml';
 import tpl from '@tryghost/tpl';
 import * as errors from '@tryghost/errors';
 
-import type {RedirectConfig} from './types';
+import type {RedirectConfig} from './redirect-config';
 
 const messages = {
     jsonParse: 'Could not parse JSON: {context}.',

ghost/core/core/server/services/custom-redirects/redirect-config.ts

@@ -0,0 +1,7 @@
+export interface RedirectConfig {
+    from: string;
+    /** Capture groups from `from` can be referenced as `$1`, `$2`, etc. */
+    to: string;
+    /** `true` → HTTP 301, otherwise HTTP 302. */
+    permanent?: boolean;
+}

ghost/core/core/server/services/custom-redirects/redirects-service.ts

@@ -3,7 +3,16 @@ import tpl from '@tryghost/tpl';
 import * as errors from '@tryghost/errors';
 
 import DynamicRedirectManager from '../lib/dynamic-redirect-manager';
-import type {RedirectConfig, RedirectsStore} from './types';
+import type {RedirectConfig} from './redirect-config';
+
+/**
+ * Concurrent `replaceAll` calls have no ordering guarantee — serialize
+ * externally if that matters.
+ */
+export interface RedirectsStore {
+    getAll(): Promise<RedirectConfig[]>;
+    replaceAll(redirects: RedirectConfig[]): Promise<void>;
+}
 
 const messages = {
     redirectsRegister: 'Could not register custom redirects.',

ghost/core/core/server/services/custom-redirects/validation.js

@@ -13,7 +13,7 @@ const messages = {
  * non-empty `from` / `to` strings, with `from` compilable as a RegExp.
  * Throws on the first failure rather than collecting errors.
  *
- * @param {import('./types').RedirectConfig[]} redirects
+ * @param {import('./redirect-config').RedirectConfig[]} redirects
  */
 const validate = (redirects) => {
     if (!_.isArray(redirects)) {

ghost/core/test/unit/server/services/custom-redirects/helpers/in-memory-store.ts

@@ -1,4 +1,5 @@
-import type {RedirectConfig, RedirectsStore} from '../../../../../../core/server/services/custom-redirects/types';
+import type {RedirectConfig} from '../../../../../../core/server/services/custom-redirects/redirect-config';
+import type {RedirectsStore} from '../../../../../../core/server/services/custom-redirects/redirects-service';
 
 export class InMemoryStore implements RedirectsStore {
     private redirects: RedirectConfig[] = [];

ghost/core/test/unit/server/services/custom-redirects/helpers/store-contract.ts

@@ -1,6 +1,6 @@
 import assert from 'node:assert/strict';
 
-import type {RedirectsStore} from '../../../../../../core/server/services/custom-redirects/types';
+import type {RedirectsStore} from '../../../../../../core/server/services/custom-redirects/redirects-service';
 
 interface ContractOptions {
     createStore: () => RedirectsStore | Promise<RedirectsStore>;