oc 0.49.3 → 0.49.7

package/src/types.ts

@@ -40,7 +40,7 @@ export interface ComponentsDetails {
 }
 
 export interface ComponentsList {
-  components: Dictionary<string[]>;
+  components: Record<string, string[]>;
   lastEdit: number;
 }
 
@@ -113,6 +113,22 @@ export interface VM {
   type: 'oc-registry' | 'oc-registry-local';
 }
 
+export type Authentication<T = any> = {
+  validate: (config: T) => {
+    isValid: boolean;
+    message: string;
+  };
+  middleware: (config: T) => any;
+};
+
+export type PublishAuthConfig =
+  | {
+      type: 'basic';
+      username: string;
+      password: string;
+    }
+  | ({ type: string | Authentication } & Record<string, any>);
+
 export interface Config {
   baseUrl: string;
   baseUrlFunc?: (opts: { host?: string; secure: boolean }) => string;
@@ -121,24 +137,21 @@ export interface Config {
   dependencies: string[];
   discovery: boolean;
   discoveryFunc?: (opts: { host?: string; secure: boolean }) => boolean;
-  env: Dictionary<string>;
+  env: Record<string, string>;
   executionTimeout?: number;
   fallbackRegistryUrl: string;
   hotReloading: boolean;
   keepAliveTimeout?: number;
   liveReloadPort: number;
+  components?: string[];
   local: boolean;
   path: string;
   plugins: Record<string, (...args: unknown[]) => void>;
   pollingInterval: number;
-  port: number;
+  port: number | string;
   postRequestPayloadSize?: number;
   prefix: string;
-  publishAuth?: {
-    type: string;
-    username: string;
-    password: string;
-  };
+  publishAuth?: PublishAuthConfig;
   publishValidation: (data: unknown) =>
     | {
         isValid: boolean;
@@ -160,7 +173,7 @@ export interface Config {
   };
   storage: {
     adapter: any;
-    options: Dictionary<any> & { componentsDir: string };
+    options: Record<string, any> & { componentsDir: string };
   };
   tempDir: string;
   templates: any[];
@@ -170,20 +183,31 @@ export interface Config {
 
 export interface Cdn {
   adapterType: string;
-  getFile: (filePath: string, cb: Callback<string>) => void;
-  getJson<T>(filePath: string, force: boolean, cb: Callback<T, string>): void;
-  getJson<T>(filePath: string, cb: Callback<T, string>): void;
+  getFile: (
+    filePath: string,
+    cb: (err: Error | null, data: string) => void
+  ) => void;
+  getJson<T>(
+    filePath: string,
+    force: boolean,
+    cb: (err: string | null, data: T) => void
+  ): void;
+  getJson<T>(filePath: string, cb: (err: string | null, data: T) => void): void;
   listSubDirectories: (
     dir: string,
-    cb: Callback<string[], Error & { code?: string }>
+    cb: (err: (Error & { code?: string }) | null, data: string[]) => void
   ) => void;
   maxConcurrentRequests: number;
-  putDir: (folderPath: string, filePath: string, cb: Callback) => void;
+  putDir: (
+    folderPath: string,
+    filePath: string,
+    cb: (err: Error | null) => void
+  ) => void;
   putFileContent: (
     data: unknown,
     path: string,
     isPrivate: boolean,
-    callback: Callback<unknown, string>
+    callback: (err: string | null, data: unknown) => void
   ) => void;
 }
 
@@ -203,7 +227,7 @@ interface CompilerOptions {
 }
 
 export interface Template {
-  compile?: (options: CompilerOptions, cb: Callback) => void;
+  compile?: (options: CompilerOptions, cb: (err: Error | null) => void) => void;
   getCompiledTemplate: (
     templateString: string,
     key: string,
@@ -212,7 +236,7 @@ export interface Template {
   getInfo: () => TemplateInfo;
   render: (
     options: { model: unknown; template: CompiledTemplate },
-    cb: Callback<string>
+    cb: (err: Error | null, data: string) => void
   ) => void;
 }
 
@@ -233,15 +257,18 @@ export interface Plugin {
 }
 
 export interface RegistryCli {
-  add(registry: string, callback: Callback<null, string>): void;
-  get(callback: Callback<string[], string>): void;
+  add(
+    registry: string,
+    callback: (err: string | null, data: null) => void
+  ): void;
+  get(callback: (err: string | null, data: string[]) => void): void;
   getApiComponentByHref(
     href: string,
-    callback: Callback<unknown, Error | number>
+    callback: (err: Error | number | null, data: unknown) => void
   ): void;
   getComponentPreviewUrlByUrl(
     componentHref: string,
-    callback: Callback<string, Error | number>
+    callback: (err: Error | number | null, data: string) => void
   ): void;
   putComponent(
     options: {
@@ -250,15 +277,21 @@ export interface RegistryCli {
       route: string;
       path: string;
     },
-    callback: Callback<unknown, string>
+    callback: (err: string | null, data: unknown) => void
   ): void;
-  remove(registry: string, callback: Callback): void;
+  remove(registry: string, callback: (err: Error | null) => void): void;
 }
 
 export interface Local {
   clean: {
-    fetchList: (dirPath: string, callback: Callback<string[]>) => void;
-    remove: (list: string[], callback: Callback<string>) => void;
+    fetchList: (
+      dirPath: string,
+      callback: (err: Error | null, data: string[]) => void
+    ) => void;
+    remove: (
+      list: string[],
+      callback: (err: Error | null, data: string) => void
+    ) => void;
   };
   cleanup: (
     compressedPackagePath: string,
@@ -271,7 +304,8 @@ export interface Local {
   ) => void;
   getComponentsByDir: (
     componentsDir: string,
-    callback: Callback<string[]>
+    componentsToRun: (err: Error | null, data: string[]) => void | string[],
+    callback: (err: Error | null, data: string[]) => void
   ) => void;
   init: (
     options: {
@@ -280,7 +314,7 @@ export interface Local {
       componentPath: string;
       templateType: string;
     },
-    callback: Callback<string, string>
+    callback: (err: string | null, data: string) => void
   ) => void;
   mock: (
     params: { targetType: string; targetValue: string; targetName: string },
@@ -293,7 +327,7 @@ export interface Local {
       verbose?: boolean;
       production?: boolean;
     },
-    callback: Callback<Component>
+    callback: (err: Error | null, data: Component) => void
   ) => void;
 }
 
@@ -301,36 +335,41 @@ export interface Repository {
   getCompiledView(
     componentName: string,
     componentVersion: string,
-    callback: Callback<string>
+    callback: (err: Error | null, data: string) => void
   ): void;
   getComponent(
     componentName: string,
     componentVersion: string,
-    calllback: Callback<Component, string>
+    calllback: (err: string | null, data: Component) => void
   ): void;
   getComponent(
     componentName: string,
-    calllback: Callback<Component, string>
+    calllback: (err: string | null, data: Component) => void
   ): void;
   getComponentInfo(
     componentName: string,
     componentVersion: string,
-    callback: Callback<Component, string>
+    callback: (err: string | null, data: Component) => void
   ): void;
   getComponentPath(componentName: string, componentVersion: string): void;
-  getComponents(callback: Callback<string[]>): void;
-  getComponentsDetails(callback: Callback<ComponentsDetails, string>): void;
+  getComponents(callback: (err: Error | null, data: string[]) => void): void;
+  getComponentsDetails(
+    callback: (err: string | null, data: ComponentsDetails) => void
+  ): void;
   getComponentVersions(
     componentName: string,
-    callback: Callback<string[], string>
+    callback: (err: string | null, data: string[]) => void
   ): void;
   getDataProvider(
     componentName: string,
     componentVersion: string,
-    callback: Callback<{
-      content: string;
-      filePath: string;
-    }>
+    callback: (
+      err: Error | null,
+      data: {
+        content: string;
+        filePath: string;
+      }
+    ) => void
   ): void;
   getStaticClientMapPath: () => string;
   getStaticClientPath: () => string;
@@ -341,12 +380,17 @@ export interface Repository {
   ) => string;
   getTemplate: (type: string) => Template;
   getTemplatesInfo: () => TemplateInfo[];
-  init(callback: Callback<ComponentsList | string>): void;
+  init(
+    callback: (err: Error | null, data: ComponentsList | string) => void
+  ): void;
   publishComponent(
     pkgDetails: any,
     componentName: string,
     componentVersion: string,
-    callback: Callback<ComponentsDetails, { code: string; msg: string }>
+    callback: (
+      err: { code: string; msg: string } | null,
+      data: ComponentsDetails
+    ) => void
   ): void;
 }
 

package/src/utils/clean-require.ts

@@ -1,9 +1,25 @@
 import tryRequire from 'try-require';
 
+export default function cleanRequire(
+  path: string,
+  opts: { justTry: true; resolve: true }
+): string | undefined;
+export default function cleanRequire(
+  path: string,
+  opts: { justTry?: false; resolve: true }
+): string;
+export default function cleanRequire<T = unknown>(
+  path: string,
+  opts: { justTry: true; resolve?: false }
+): T | undefined;
+export default function cleanRequire<T = unknown>(
+  path: string,
+  opts: { justTry?: false; resolve?: false }
+): T;
 export default function cleanRequire(
   path: string,
   { justTry = false, resolve = false }: { justTry?: boolean; resolve?: boolean }
-): any {
+) {
   const shouldThrow = !justTry;
 
   if (require.cache && !!require.cache[path]) {

package/src/utils/date-stringify.ts

@@ -1,19 +1,21 @@
-import padZero from './pad-zero';
+function padTwoDigits(data: number): string {
+  return String(data).padStart(2, '0');
+}
 
 export default function dateStringify(date: unknown): string {
   if (date instanceof Date) {
     return (
       date.getFullYear() +
       '/' +
-      padZero(2, date.getMonth() + 1) +
+      padTwoDigits(date.getMonth() + 1) +
       '/' +
-      padZero(2, date.getDate()) +
+      padTwoDigits(date.getDate()) +
       ' ' +
-      padZero(2, date.getHours()) +
+      padTwoDigits(date.getHours()) +
       ':' +
-      padZero(2, date.getMinutes()) +
+      padTwoDigits(date.getMinutes()) +
       ':' +
-      padZero(2, date.getSeconds())
+      padTwoDigits(date.getSeconds())
     );
   }
 

package/src/utils/npm-utils.ts

@@ -65,7 +65,7 @@ export const installDependencies = (
     silent: boolean;
     usePrefix: boolean;
   },
-  callback: Callback<{ dest: string }, string | number>
+  callback: (err: string | number | null, data: { dest: string }) => void
 ): void => {
   const { dependencies, installPath, silent } = options;
   const npmi = buildInstallCommand(options);
@@ -91,7 +91,7 @@ export const installDependency = (
     silent?: boolean;
     usePrefix: boolean;
   },
-  callback: Callback<{ dest: string }, string | number>
+  callback: (err: string | number | null, data: { dest: string }) => void
 ): void => {
   const { dependency, installPath, silent } = options;
   const npmi = buildInstallCommand(options);

package/src/utils/put.ts

@@ -6,8 +6,10 @@ import url from 'url';
 export default function put(
   urlPath: string,
   files: string | string[],
-  headers: Record<string, string> | Callback<any, Error | string>,
-  callback: Callback<any, Error | string>
+  headers:
+    | Record<string, string>
+    | ((err: Error | string | null, data: any) => void),
+  callback: (err: Error | string | null, data: any) => void
 ): void {
   if (typeof headers === 'function') {
     callback = headers;

package/tsconfig.json

@@ -85,13 +85,13 @@
     "useUnknownInCatchVariables": true /* Type catch clause variables as 'unknown' instead of 'any'. */,
     "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
     "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
-    // "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
+    "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
     // "exactOptionalPropertyTypes": true /* Interpret optional property types as written, rather than adding 'undefined'. */,
-    // "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
+    "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
     "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
     // "noUncheckedIndexedAccess": true /* Include 'undefined' in index signature results */,
     "noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,
-    // "noPropertyAccessFromIndexSignature": true /* Enforces using indexed accessors for keys declared using an indexed type */,
+    "noPropertyAccessFromIndexSignature": true /* Enforces using indexed accessors for keys declared using an indexed type */,
     "allowUnusedLabels": false /* Disable error reporting for unused labels. */,
     "allowUnreachableCode": false /* Disable error reporting for unreachable code. */,
 

package/dist/utils/pad-zero.d.ts

@@ -1 +0,0 @@
-export default function padZero(length: number, data: number): string;

package/dist/utils/pad-zero.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function padZero(length, data) {
-    return Array(length - String(data).length + 1).join('0') + data;
-}
-exports.default = padZero;

package/src/utils/pad-zero.ts

@@ -1,3 +0,0 @@
-export default function padZero(length: number, data: number): string {
-  return Array(length - String(data).length + 1).join('0') + data;
-}