@verdaccio/types 13.0.0-next-8.4 → 13.0.0-next-8.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdaccio/types",
-  "version": "13.0.0-next-8.4",
+  "version": "13.0.0-next-8.6",
   "description": "Verdaccio Type Definitions",
   "keywords": [
     "private",
@@ -33,6 +33,8 @@
   "main": "src/types.ts",
   "types": "src/types.ts",
   "devDependencies": {
+    "@types/jsonwebtoken": "9.0.6",
+    "@types/ms": "2.1.0",
     "typedoc": "0.23.25"
   },
   "typedoc": {

package/src/configuration.ts

@@ -1,3 +1,4 @@
+import { Algorithm as Algorithms, SignOptions, VerifyOptions } from 'jsonwebtoken';
 import { AgentOptions as HttpAgentOptions } from 'node:http';
 import { AgentOptions as HttpsAgentOptions } from 'node:https';
 
@@ -75,9 +76,10 @@ export type RateLimit = {
 export type FlagsConfig = {
   searchRemote?: boolean;
   changePassword?: boolean;
+  webLogin?: boolean;
 };
 
-export type PackageManagers = 'pnpm' | 'yarn' | 'npm';
+export type PackageManagers = 'pnpm' | 'yarn' | 'npm' | string;
 
 // FUTURE: WebConf and TemplateUIOptions should be merged .
 export type CommonWebConf = {
@@ -101,7 +103,7 @@ export type CommonWebConf = {
   showDownloadTarball?: boolean;
   showUplinks?: boolean;
   hideDeprecatedVersions?: boolean;
-  primaryColor: string;
+  primaryColor?: string;
   showRaw?: boolean;
 };
 
@@ -116,7 +118,7 @@ export type TemplateUIOptions = {
   basename?: string;
   base: string;
   version?: string;
-  flags: FlagsConfig;
+  flags?: FlagsConfig;
 } & CommonWebConf;
 
 /**
@@ -126,10 +128,14 @@ export type WebConf = {
   // @deprecated use primaryColor
   primary_color?: string;
   primaryColor?: string;
+  // @deprecated use enabled
   enable?: boolean;
+  enabled?: boolean;
   scriptsHead?: string[];
   scriptsBodyAfter?: string[];
+  // @deprecated use scriptsBodyBefore
   scriptsbodyBefore?: string[];
+  scriptsBodyBefore?: string[];
   metaScripts?: string[];
   bodyBefore?: string[];
   bodyAfter?: string[];
@@ -153,34 +159,10 @@ export interface JWTOptions {
   verify: JWTVerifyOptions;
 }
 
-export type Algorithm =
-  | 'HS256'
-  | 'HS384'
-  | 'HS512'
-  | 'RS256'
-  | 'RS384'
-  | 'RS512'
-  | 'ES256'
-  | 'ES384'
-  | 'ES512'
-  | 'PS256'
-  | 'PS384'
-  | 'PS512'
-  | 'none';
-
-export interface JWTSignOptions {
-  algorithm?: Algorithm | undefined;
-  expiresIn?: string | number | undefined;
-  notBefore?: string | number | undefined;
-}
+export type Algorithm = Algorithms;
 
-export interface JWTVerifyOptions {
-  algorithm?: Algorithm | undefined;
-  notBefore?: string | number;
-  ignoreExpiration?: boolean;
-  maxAge?: string | number;
-  clockTimestamp?: number;
-}
+export interface JWTSignOptions extends SignOptions {}
+export interface JWTVerifyOptions extends VerifyOptions {}
 
 export interface APITokenOptions {
   legacy: boolean;
@@ -306,6 +288,7 @@ export interface Config extends Omit<ConfigYaml, 'packages' | 'security' | 'conf
   security: Security;
   // @deprecated (pending adding the replacement)
   checkSecretKey(token: string | void): string;
+  // @deprecated use core.authUtils instead
   getMatchedPackagesSpec(storage: string): PackageAccess | void;
   // TODO: verify how to handle this in the future
   [key: string]: any;

package/src/manifest.ts

@@ -79,8 +79,11 @@ export interface Author {
   name: string;
   email?: string;
   url?: string;
+  _avatar?: string; // for web ui
 }
 
+export type Person = Author | string;
+
 export interface PackageUsers {
   [key: string]: boolean;
 }
@@ -100,7 +103,7 @@ export interface Version {
   version: string;
   directories?: any;
   dist: Dist;
-  author: string | Author;
+  author: Person;
   main: string;
   homemage?: string;
   license?: string;
@@ -112,8 +115,8 @@ export interface Version {
   bugs?: any;
   files?: string[];
   gitHead?: string;
-  maintainers?: Author[];
-  contributors?: Author[];
+  maintainers?: Person[];
+  contributors?: Person[];
   repository?: string | any;
   scripts?: any;
   homepage?: string;
@@ -180,8 +183,8 @@ export interface FullRemoteManifest {
   time: GenericBody;
   versions: Versions;
   /** store owners of this package */
-  maintainers?: Author[];
-  contributors?: Author[];
+  maintainers?: Person[];
+  contributors?: Person[];
   /** store the latest readme **/
   readme?: string;
   /** store star assigned to this packages by users */
@@ -193,7 +196,7 @@ export interface FullRemoteManifest {
   homepage?: string;
   repository?: string | { type?: string; url: string; directory?: string };
   keywords?: string[];
-  author?: string | Author;
+  author?: Person;
 }
 
 export interface Manifest extends FullRemoteManifest, PublishManifest {
@@ -281,3 +284,11 @@ export interface PublishManifest {
    * */
   _attachments: AttachMents;
 }
+
+/**
+ * Web user interface hoists the selected version to "latest" and adds "dist.tarball" field.
+ */
+export interface WebManifest extends Manifest {
+  latest?: Version;
+  dist?: { tarball: string };
+}