@playdrop/playdrop-cli 0.16.5 → 0.16.11

package/dist/catalogue.d.ts

@@ -1,5 +1,5 @@
-import { type AppAchievementCatalogueDefinition, type AppAuthMode, type AppControllerMode, type AppHostingMode, type AppLeaderboardCatalogueDefinition, type AppListingMediaMetadata, type AppMetadataAssetSpecSupport, type AppPlaytestTapes, type AppSurface, type AppType, type AppTweaksDeclaration, type AppVersionDesign, type AppVersionVisibility, type AssetSpecContract, type AssetSpecStatus, type AssetSpecValidationKind, type CatalogueTagGroupDefinition, type ContentLicense, type PlayerMetaDefinitionStatus } from '@playdrop/types';
-import { type AssetSpecSupportDeclaration } from './assetSpecs';
+import { type AppAchievementCatalogueDefinition, type AppAuthMode, type AppControllerMode, type AppHostingMode, type AppLeaderboardCatalogueDefinition, type AppListingMediaMetadata, type AppMetadataAssetSpecSupport, type AppPlaytestTapes, type AppSurface, type AppType, type AppTweaksDeclaration, type AppVersionDesign, type AppVersionVisibility, type AssetSpecContract, type AssetSpecStatus, type AssetSpecValidationKind, type CatalogueTagGroupDefinition, type ContentLicense, type PlayerMetaDefinitionStatus } from "@playdrop/types";
+import { type AssetSpecSupportDeclaration } from "./assetSpecs";
 export type CatalogueJson = {
     apps?: Array<Record<string, unknown>>;
     tagGroups?: CatalogueTagGroupDefinition[];
@@ -9,6 +9,10 @@ export type CatalogueJson = {
 } & Record<string, unknown>;
 export declare const APP_DESCRIPTION_RECOMMENDED_MIN_CHARACTERS = 120;
 export declare const APP_DESCRIPTION_RECOMMENDED_MIN_WORDS = 20;
+export declare const APP_RELEASE_NOTES_MAX_CHARACTERS = 240;
+export declare function normalizeAppReleaseNotes(value: string | undefined, options?: {
+    required?: boolean;
+}): string | undefined;
 /**
  * Listing assets configuration for an app version.
  * All paths are relative to the catalogue.json directory.
@@ -31,11 +35,11 @@ export type AppListingMediaConfig = string | {
     caption?: string;
     description?: string;
 };
-export type ResolvedAppAchievementDefinition = Omit<AppAchievementCatalogueDefinition, 'status'> & {
+export type ResolvedAppAchievementDefinition = Omit<AppAchievementCatalogueDefinition, "status"> & {
     iconPath: string;
     status: PlayerMetaDefinitionStatus;
 };
-export type ResolvedAppLeaderboardDefinition = Omit<AppLeaderboardCatalogueDefinition, 'status'> & {
+export type ResolvedAppLeaderboardDefinition = Omit<AppLeaderboardCatalogueDefinition, "status"> & {
     status: PlayerMetaDefinitionStatus;
 };
 export type AppCatalogueEntry = {
@@ -176,7 +180,7 @@ export type AppDependencyAssetRef = {
     runtimeKey?: string;
 };
 export type AppTask = {
-    kind: 'app';
+    kind: "app";
     name: string;
     cataloguePath: string;
     catalogueAbsolutePath: string;
@@ -232,7 +236,7 @@ export type AppTask = {
     };
 };
 export type AssetTask = {
-    kind: 'asset';
+    kind: "asset";
     name: string;
     displayName?: string;
     cataloguePath: string;
@@ -256,7 +260,7 @@ export type AssetTask = {
     }>;
 };
 export type AssetSpecTask = {
-    kind: 'asset-spec';
+    kind: "asset-spec";
     name: string;
     version: string;
     displayName: string;
@@ -265,7 +269,7 @@ export type AssetSpecTask = {
     catalogueAbsolutePath: string;
     catalogueDir: string;
     username?: string;
-    visibility?: 'PUBLIC' | 'PRIVATE';
+    visibility?: "PUBLIC" | "PRIVATE";
     validationKind: AssetSpecValidationKind;
     status: AssetSpecStatus;
     releaseNotes?: string;
@@ -276,7 +280,7 @@ export type AssetSpecTask = {
     contract: AssetSpecContract;
 };
 export type OwnedAssetTask = {
-    kind: 'owned-asset';
+    kind: "owned-asset";
     appName: string;
     name: string;
     runtimeKey?: string;
@@ -315,7 +319,7 @@ export type PackOwnedAssetTask = {
     filePaths: Record<string, string>;
 };
 export type AssetPackTask = {
-    kind: 'asset-pack';
+    kind: "asset-pack";
     name: string;
     displayName?: string;
     version: string;
@@ -340,6 +344,7 @@ export type AssetPackTask = {
 export type CatalogueLoadOptions = {
     filterName?: string;
     filterFile?: string;
+    listingAssets?: "resolve" | "ignore";
 };
 export type CatalogueLoadResult = {
     apps: AppTask[];
@@ -376,18 +381,18 @@ export type ValidatedAppMetadata = {
     errors: string[];
 };
 type WorkspaceResolution = {
-    kind: 'app';
+    kind: "app";
     task: AppTask;
     warnings: string[];
 } | {
-    kind: 'file';
+    kind: "file";
     htmlPath: string;
 } | {
-    kind: 'directory';
+    kind: "directory";
     cataloguePath: string;
 } | {
-    kind: 'not_found';
-    reason: 'catalogue_missing' | 'multiple_apps' | 'app_missing' | 'no_apps';
+    kind: "not_found";
+    reason: "catalogue_missing" | "multiple_apps" | "app_missing" | "no_apps";
     message: string;
 };
 export type WorkspaceAppResolution = WorkspaceResolution;
@@ -405,7 +410,7 @@ export declare function formatMissingMetadataWarnings(task: {
     cataloguePath: string;
     missingMetadata: string[];
 }): string | undefined;
-export declare function findAppTaskByFile(htmlPath: string): {
+export declare function findAppTaskByFile(htmlPath: string, options?: Pick<CatalogueLoadOptions, "listingAssets">): {
     task?: AppTask;
     warnings: string[];
     errors: string[];