Rename KVAssets to Assets

Author: harmony7

src/cli/commands/manage/clean.ts

@@ -7,7 +7,7 @@ import path from 'node:path';
 
 import { type OptionDefinition } from 'command-line-args';
 
-import { type KVAssetEntryMap } from '../../../models/assets/kvstore-assets.js';
+import { type AssetEntryMap } from '../../../models/assets/index.js';
 import { type IndexMetadata } from '../../../models/server/index.js';
 import { isExpired } from '../../../models/time/index.js';
 import { type FastlyApiContext, loadApiToken } from '../../util/api-token.js';
@@ -251,7 +251,7 @@ export async function action(actionArgs: string[]) {
       }
 
       liveCollections.add(collection);
-      const kvAssetsIndex = (await kvAssetsIndexResponse.response.json()) as KVAssetEntryMap;
+      const kvAssetsIndex = (await kvAssetsIndexResponse.response.json()) as AssetEntryMap;
       for (const [_assetKey, assetEntry] of Object.entries(kvAssetsIndex)) {
         if (assetEntry.key.startsWith('sha256:')) {
           assetsIdsInUse.add(`sha256_${assetEntry.key.slice('sha256:'.length)}`);

src/cli/commands/manage/publish-content.ts

@@ -8,7 +8,7 @@ import * as path from 'node:path';
 
 import { type OptionDefinition } from 'command-line-args';
 
-import { type KVAssetEntryMap, type KVAssetVariantMetadata, isKVAssetVariantMetadata } from '../../../models/assets/kvstore-assets.js';
+import { type AssetEntryMap, type AssetVariantMetadata, isAssetVariantMetadata } from '../../../models/assets/index.js';
 import { type ContentCompressionTypes } from '../../../models/compression/index.js';
 import { type PublisherServerConfigNormalized } from '../../../models/config/publisher-server-config.js';
 import { type ContentTypeDef } from '../../../models/config/publish-content-config.js';
@@ -322,10 +322,10 @@ export async function action(actionArgs: string[]) {
   const kvStoreItemDescriptions: KVStoreItemDesc[] = [];
 
   // Assets included in the publishing, keyed by asset key
-  const kvAssetsIndex: KVAssetEntryMap = {};
+  const kvAssetsIndex: AssetEntryMap = {};
 
   // All the metadata of the variants we know about during this publishing, keyed on the base version's hash.
-  type VariantMetadataEntry = KVAssetVariantMetadata & {
+  type VariantMetadataEntry = AssetVariantMetadata & {
     existsInKvStore: boolean,
   };
   type VariantMetadataMap = Map<Variants, VariantMetadataEntry>;
@@ -406,7 +406,7 @@ export async function action(actionArgs: string[]) {
 
       } else {
 
-        let kvStoreItemMetadata: KVAssetVariantMetadata | null = null;
+        let kvStoreItemMetadata: AssetVariantMetadata | null = null;
 
         if (!localMode && !overwriteKvStoreItems) {
           const items = [{
@@ -430,7 +430,7 @@ export async function action(actionArgs: string[]) {
                   // treat it as though it didn't exist.
                 }
               }
-              if (isKVAssetVariantMetadata(itemMetadata)) {
+              if (isAssetVariantMetadata(itemMetadata)) {
                 let exists = false;
                 if (itemMetadata.size <= KV_STORE_CHUNK_SIZE) {
                   // For an item equal to or smaller than the chunk size, if it exists
@@ -461,7 +461,7 @@ export async function action(actionArgs: string[]) {
           );
         }
 
-        if ((kvStoreItemMetadata as KVAssetVariantMetadata | null) != null) {
+        if ((kvStoreItemMetadata as AssetVariantMetadata | null) != null) {
 
           console.log(` ・ Asset found in KV Store with key "${variantKey}".`);
           // And we already know its hash and size.

src/models/assets/index.ts

@@ -5,24 +5,24 @@
 
 import { type ContentCompressionTypes, isCompressionType } from '../compression/index.js';
 
-export type KVAssetEntry = {
+export type AssetEntry = {
   key: string,
   size: number,
   contentType: string,
   lastModifiedTime: number,
   variants: ContentCompressionTypes[],
 };
 
-export type KVAssetEntryMap = Record<string, KVAssetEntry>;
+export type AssetEntryMap = Record<string, AssetEntry>;
 
-export type KVAssetVariantMetadata = {
+export type AssetVariantMetadata = {
   contentEncoding?: ContentCompressionTypes,
   size: number,
   hash: string,
   numChunks?: number,
 };
 
-export function isKVAssetVariantMetadata(obj: unknown): obj is KVAssetVariantMetadata {
+export function isAssetVariantMetadata(obj: unknown): obj is AssetVariantMetadata {
   if (obj == null || typeof obj !== 'object') {
     return false;
   }

src/server/publisher-server/index.ts

@@ -16,11 +16,11 @@ import {
   type ContentCompressionTypes,
 } from '../../models/compression/index.js';
 import {
-  isKVAssetVariantMetadata,
-  type KVAssetEntry,
-  type KVAssetEntryMap,
-  type KVAssetVariantMetadata,
-} from '../../models/assets/kvstore-assets.js';
+  isAssetVariantMetadata,
+  type AssetEntry,
+  type AssetEntryMap,
+  type AssetVariantMetadata,
+} from '../../models/assets/index.js';
 import { type IndexMetadata } from '../../models/server/index.js';
 import { isExpired } from '../../models/time/index.js';
 import { getKVStoreEntry } from '../util/kv-store.js';
@@ -29,7 +29,7 @@ import { checkIfNoneMatch, getIfNoneMatchHeader } from './serve-preconditions/if
 
 type KVAssetVariant = {
   kvStoreEntry: KVStoreEntry,
-} & KVAssetVariantMetadata;
+} & AssetVariantMetadata;
 
 export function buildHeadersSubset(responseHeaders: Headers, keys: Readonly<string[]>) {
   const resultHeaders = new Headers();
@@ -98,7 +98,7 @@ export class PublisherServer {
   settingsCached: PublisherServerConfigNormalized | null | undefined;
 
   // Cached index
-  kvAssetsIndex: KVAssetEntryMap | null | undefined;
+  kvAssetsIndex: AssetEntryMap | null | undefined;
 
   setActiveCollectionName(collectionName: string) {
     this.activeCollectionName = collectionName;
@@ -180,11 +180,11 @@ export class PublisherServer {
       return null;
     }
 
-    this.kvAssetsIndex = (await indexFile.json()) as KVAssetEntryMap;
+    this.kvAssetsIndex = (await indexFile.json()) as AssetEntryMap;
     return this.kvAssetsIndex;
   }
 
-  async getMatchingAsset(assetKey: string, applyAuto: boolean = false): Promise<KVAssetEntry | null> {
+  async getMatchingAsset(assetKey: string, applyAuto: boolean = false): Promise<AssetEntry | null> {
 
     const serverConfig = await this.getServerConfig();
     if (serverConfig == null) {
@@ -309,7 +309,7 @@ export class PublisherServer {
       });
   }
 
-  handlePreconditions(request: Request, asset: KVAssetEntry, responseHeaders: Headers): Response | null {
+  handlePreconditions(request: Request, asset: AssetEntry, responseHeaders: Headers): Response | null {
     // Handle preconditions according to https://httpwg.org/specs/rfc9110.html#rfc.section.13.2.2
 
     // A recipient cache or origin server MUST evaluate the request preconditions defined by this specification in the following order:
@@ -370,7 +370,7 @@ export class PublisherServer {
     return null;
   }
 
-  public async loadKvAssetVariant(entry: KVAssetEntry, variant: ContentCompressionTypes | null): Promise<KVAssetVariant | null> {
+  public async loadKvAssetVariant(entry: AssetEntry, variant: ContentCompressionTypes | null): Promise<KVAssetVariant | null> {
 
     const kvStore = new KVStore(this.kvStoreName);
 
@@ -392,7 +392,7 @@ export class PublisherServer {
     } catch {
       return null;
     }
-    if (!isKVAssetVariantMetadata(metadata)) {
+    if (!isAssetVariantMetadata(metadata)) {
       return null;
     }
     if (metadata.size == null) {
@@ -404,7 +404,7 @@ export class PublisherServer {
     };
   }
 
-  private async findKVAssetVariantForAcceptEncodingsGroups(entry: KVAssetEntry, acceptEncodingsGroups: ContentCompressionTypes[][] = []): Promise<KVAssetVariant> {
+  private async findKVAssetVariantForAcceptEncodingsGroups(entry: AssetEntry, acceptEncodingsGroups: ContentCompressionTypes[][] = []): Promise<KVAssetVariant> {
 
     if (!entry.key.startsWith('sha256:')) {
       throw new TypeError(`Key must start with 'sha256:': ${entry.key}`);
@@ -445,7 +445,7 @@ export class PublisherServer {
     return baseKvStoreEntry;
   }
 
-  async serveAsset(request: Request, asset: KVAssetEntry, init?: AssetInit): Promise<Response> {
+  async serveAsset(request: Request, asset: AssetEntry, init?: AssetInit): Promise<Response> {
 
     const headers = new Headers(init?.headers);
     headers.set('Content-Type', asset.contentType);