@bett3r-dev/pv3-types 1.0.0 → 1.11.0

package/package.json

@@ -1,15 +1,30 @@
 {
   "name": "@bett3r-dev/pv3-types",
-  "version": "1.0.0",
+  "version": "1.11.0",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "license": "MIT",
   "scripts": {
-    "clean": "yarn run -T tsc --build --clean",
-    "prebuild": "yarn clean",
-    "build": "yarn run -T tsc --build --verbose"
+    "clean": "rm -rf build && rm -rf *.tsbuildinfo",
+    "build": "yarn run -T tsgo --build --verbose"
   },
   "dependencies": {
-    "@bett3r-dev/jsonschema-definer": "^1.4.4"
-  }
-}
+    "@bett3r-dev/jsonschema-definer": "^1.5.9",
+    "json-schema": "^0.4.0",
+    "openapi-types": "^12.1.3",
+    "ts-toolbelt": "^6"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bett3r-dev/pv3.git",
+    "directory": "packages/pv3-types"
+  },
+  "files": [
+    "build/**/*",
+    "README.md"
+  ]
+}

package/build/eventsourcing/utils.d.ts

@@ -1,4 +0,0 @@
-import { CommittedEvent, EventFactory, EventHandler, GetMessageType, System } from '.';
-import { O } from 'ts-toolbelt';
-export type CreateEventType<Handler extends System | EventHandler> = <EVENT extends keyof O.Path<Handler, ['events']>>(event: EVENT, data?: GetMessageType<Handler['events'][EVENT]>, committedEvent?: Partial<Omit<CommittedEvent, 'data' | 'name'>>) => EventFactory<EVENT, GetMessageType<Handler['events'][EVENT]>>;
-//# sourceMappingURL=utils.d.ts.map

package/build/eventsourcing/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/eventsourcing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,CAAC;AACvF,OAAO,EAAE,CAAC,EAAE,MAAM,aAAa,CAAC;AAEhC,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,MAAM,GAAG,YAAY,IAAI,CAAC,KAAK,SAAS,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAG,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,KAAM,YAAY,CAAC,KAAK,EAAE,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC"}

package/build/eventsourcing/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/eventsourcing/utils.ts"],"names":[],"mappings":""}

package/build/validation.d.ts

@@ -1,64 +0,0 @@
-import { BaseSchema } from '@bett3r-dev/jsonschema-definer';
-export type AppErrorInstance<ErrorPayload = unknown> = Error & AppErrorData<ErrorPayload>;
-export type AppErrorData<ErrorPayload = unknown> = {
-    error?: string;
-    description?: string;
-    type: ErrorTypes;
-    details?: ErrorPayload;
-    status?: number;
-};
-export type AppErrorType<ErrorPayload = any> = AppErrorData<ErrorPayload> & {
-    schema?: BaseSchema<ErrorPayload>;
-};
-/**
- * @hidden
- */
-export declare const errorStatusCodeMap: {
-    BadRequestError: number;
-    UnauthorizedError: number;
-    PaymentRequiredError: number;
-    ForbiddenError: number;
-    NotFoundError: number;
-    MethodNotAllowedError: number;
-    NotAcceptableError: number;
-    ProxyAuthenticationRequiredError: number;
-    RequestTimeoutError: number;
-    ConflictError: number;
-    ConcurrencyError: number;
-    GoneError: number;
-    LengthRequiredError: number;
-    PreconditionFailedError: number;
-    PayloadTooLargeError: number;
-    TooManyRequestsError: number;
-    InternalServerError: number;
-    NotImplementedError: number;
-    BadGatewayError: number;
-    ServiceUnavailableError: number;
-    GatewayTimeoutError: number;
-};
-export declare const statusCodeErrorMap: {
-    400: string;
-    401: string;
-    402: string;
-    403: string;
-    404: string;
-    405: string;
-    406: string;
-    407: string;
-    408: string;
-    409: string;
-    410: string;
-    411: string;
-    412: string;
-    413: string;
-    429: string;
-    500: string;
-    501: string;
-    502: string;
-    503: string;
-    504: string;
-};
-declare const ErrorTypesSchema: BaseSchema<"BadRequestError" | "UnauthorizedError" | "PaymentRequiredError" | "ForbiddenError" | "NotFoundError" | "MethodNotAllowedError" | "NotAcceptableError" | "ProxyAuthenticationRequiredError" | "RequestTimeoutError" | "ConflictError" | "ConcurrencyError" | "GoneError" | "LengthRequiredError" | "PreconditionFailedError" | "PayloadTooLargeError" | "TooManyRequestsError" | "InternalServerError" | "NotImplementedError" | "BadGatewayError" | "ServiceUnavailableError" | "GatewayTimeoutError", true, Readonly<import("@bett3r-dev/jsonschema-definer/dist/base").BaseJsonSchema>>;
-export type ErrorTypes = typeof ErrorTypesSchema.type;
-export {};
-//# sourceMappingURL=validation.d.ts.map

package/build/validation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAU,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAE/D,MAAM,MAAM,gBAAgB,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,CAAA;AACzF,MAAM,MAAM,YAAY,CAAC,YAAY,GAAG,OAAO,IAAI;IACjD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAC,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,YAAY,GAAG,GAAG,IAAI,YAAY,CAAC,YAAY,CAAC,GAAG;IAAC,MAAM,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAA;CAAC,CAAA;AAE/G;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;CAsB9B,CAAC;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;CAqB9B,CAAC;AAGF,QAAA,MAAM,gBAAgB,ukBAsBrB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAC"}

package/build/validation.js

@@ -1,57 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodeErrorMap = exports.errorStatusCodeMap = void 0;
-const jsonschema_definer_1 = __importDefault(require("@bett3r-dev/jsonschema-definer"));
-/**
- * @hidden
- */
-exports.errorStatusCodeMap = {
-    BadRequestError: 400,
-    UnauthorizedError: 401,
-    PaymentRequiredError: 402,
-    ForbiddenError: 403,
-    NotFoundError: 404,
-    MethodNotAllowedError: 405,
-    NotAcceptableError: 406,
-    ProxyAuthenticationRequiredError: 407,
-    RequestTimeoutError: 408,
-    ConflictError: 409,
-    ConcurrencyError: 409,
-    GoneError: 410,
-    LengthRequiredError: 411,
-    PreconditionFailedError: 412,
-    PayloadTooLargeError: 413,
-    TooManyRequestsError: 429,
-    InternalServerError: 500,
-    NotImplementedError: 501,
-    BadGatewayError: 502,
-    ServiceUnavailableError: 503,
-    GatewayTimeoutError: 504,
-};
-exports.statusCodeErrorMap = {
-    400: 'BadRequestError',
-    401: 'UnauthorizedError',
-    402: 'PaymentRequiredError',
-    403: 'ForbiddenError',
-    404: 'NotFoundError',
-    405: 'MethodNotAllowedError',
-    406: 'NotAcceptableError',
-    407: 'ProxyAuthenticationRequiredError',
-    408: 'RequestTimeoutError',
-    409: 'ConcurrencyError',
-    410: 'GoneError',
-    411: 'LengthRequiredError',
-    412: 'PreconditionFailedError',
-    413: 'PayloadTooLargeError',
-    429: 'TooManyRequestsError',
-    500: 'InternalServerError',
-    501: 'NotImplementedError',
-    502: 'BadGatewayError',
-    503: 'ServiceUnavailableError',
-    504: 'GatewayTimeoutError',
-};
-const ErrorTypesSchema = jsonschema_definer_1.default.string().enum('BadRequestError', 'UnauthorizedError', 'PaymentRequiredError', 'ForbiddenError', 'NotFoundError', 'MethodNotAllowedError', 'NotAcceptableError', 'ProxyAuthenticationRequiredError', 'RequestTimeoutError', 'ConflictError', 'ConcurrencyError', 'GoneError', 'LengthRequiredError', 'PreconditionFailedError', 'PayloadTooLargeError', 'TooManyRequestsError', 'InternalServerError', 'NotImplementedError', 'BadGatewayError', 'ServiceUnavailableError', 'GatewayTimeoutError');
-//# sourceMappingURL=validation.js.map

package/build/validation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":";;;;;;AAAA,wFAA+D;AAa/D;;GAEG;AACU,QAAA,kBAAkB,GAAG;IAChC,eAAe,EAAE,GAAG;IACpB,iBAAiB,EAAE,GAAG;IACtB,oBAAoB,EAAE,GAAG;IACzB,cAAc,EAAE,GAAG;IACnB,aAAa,EAAE,GAAG;IAClB,qBAAqB,EAAE,GAAG;IAC1B,kBAAkB,EAAE,GAAG;IACvB,gCAAgC,EAAE,GAAG;IACrC,mBAAmB,EAAE,GAAG;IACxB,aAAa,EAAE,GAAG;IAClB,gBAAgB,EAAE,GAAG;IACrB,SAAS,EAAE,GAAG;IACd,mBAAmB,EAAE,GAAG;IACxB,uBAAuB,EAAE,GAAG;IAC5B,oBAAoB,EAAE,GAAG;IACzB,oBAAoB,EAAE,GAAG;IACzB,mBAAmB,EAAE,GAAG;IACxB,mBAAmB,EAAE,GAAG;IACxB,eAAe,EAAE,GAAG;IACpB,uBAAuB,EAAE,GAAG;IAC5B,mBAAmB,EAAE,GAAG;CACzB,CAAC;AAEW,QAAA,kBAAkB,GAAG;IAChC,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,mBAAmB;IACxB,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,gBAAgB;IACrB,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,uBAAuB;IAC5B,GAAG,EAAE,oBAAoB;IACzB,GAAG,EAAE,kCAAkC;IACvC,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,kBAAkB;IACvB,GAAG,EAAE,WAAW;IAChB,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,sBAAsB;IAC3B,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,qBAAqB;IAC1B,GAAG,EAAE,iBAAiB;IACtB,GAAG,EAAE,yBAAyB;IAC9B,GAAG,EAAE,qBAAqB;CAC3B,CAAC;AAGF,MAAM,gBAAgB,GAAG,4BAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CACtC,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,gBAAgB,EAChB,eAAe,EACf,uBAAuB,EACvB,oBAAoB,EACpB,kCAAkC,EAClC,qBAAqB,EACrB,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACrB,iBAAiB,EACjB,yBAAyB,EACzB,qBAAqB,CACtB,CAAC"}

package/src/authentication.ts

@@ -1,273 +0,0 @@
-import S, { mergeMultipleSchemas, mergeSchemas, omitFromSchema } from '@bett3r-dev/jsonschema-definer';
-import { RoutesAuthManagerType } from './routesAuth';
-import { ClusterRoutesConfigType } from './clusterAdministration';
-import { AdapterBase, PortEmitter } from './ports';
-import { Ports } from './ports';
-
-//*******************************************
-// Schemas
-//*******************************************
-/**
- * @category Schemas
- */
-export const AuthenticationIdSchema = S.shape({
-  id: S.string()
-});
-/**
- * @category Schemas
- */
-export const AuthenticationEmailSchema = S.shape({
-  email: S.string().format( 'email' )
-});
-export type AuthenticationEmail = typeof AuthenticationEmailSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationPasswordSchema = S.shape({
-  password: S.string()
-});
-export type AuthenticationPassword = typeof AuthenticationPasswordSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationRoleSchema = S.shape({
-  role: S.string(),
-});
-
-/**
- * @category Schemas
- */
-export const AuthenticationRolesSchema = S.shape({
-  roles: S.array().items( S.string()),
-});
-export type AuthenticationRolesType = typeof AuthenticationRolesSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationProviderIdSchema = S.shape({
-  providerId: S.string(),
-  providerName: S.string(),
-});
-export type AuthenticationProviderId = typeof AuthenticationProviderIdSchema.type
-
-/**
- * @category Schemas
- */
-export const AuthenticationProviderUserSchema = mergeSchemas( AuthenticationEmailSchema, AuthenticationProviderIdSchema );
-
-/**
- * @category Schemas
- */
-export const UserLoginSchema = mergeSchemas( AuthenticationEmailSchema, AuthenticationPasswordSchema );
-export type UserLogin = typeof UserLoginSchema.type
-
-/**
- * @category Schemas
- */
-export const AuthenticationRegistrationSchema = mergeSchemas( UserLoginSchema, AuthenticationRolesSchema );
-export type AuthenticationRegistrationType = typeof AuthenticationRegistrationSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationCustomAttributesSchema = S.shape({
-  attributes: S.shape({}).additionalProperties( true ).optional()
-});
-export type AuthenticationCustomAttributesType = typeof AuthenticationCustomAttributesSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationUserSchema = mergeMultipleSchemas( AuthenticationIdSchema, AuthenticationEmailSchema, AuthenticationRolesSchema, AuthenticationCustomAttributesSchema );
-export type AuthenticationUser = typeof AuthenticationUserSchema.type;
-
-
-/**
- * @category Schemas
- */
-export const AuthenticationCreateUserCommandSchema = mergeSchemas( AuthenticationUserSchema, AuthenticationPasswordSchema );
-export type AuthenticationCreateUserCommand = typeof AuthenticationCreateUserCommandSchema.type
-
-export const AuthenticationUpdateUserCommandSchema = mergeSchemas( omitFromSchema( AuthenticationCreateUserCommandSchema, [ 'password', 'id', 'roles' ]).partial(), S.shape({ providerId: S.string() }));
-export type AuthenticationUpdateUserCommand = typeof AuthenticationUpdateUserCommandSchema.type;
-
-/**
- * @category Schemas
- */
-export const AuthenticationResponseSchema = mergeSchemas( AuthenticationRolesSchema, S.shape({
-  'expires_in': S.number(),
-  'refresh_expires_in': S.number(),
-  'not-before-policy': S.number(),
-  'access_token': S.string(),
-  'refresh_token': S.string(),
-  'token_type': S.string(),
-  'session_state': S.string(),
-  'scope': S.string(),
-}));
-export type AuthenticationResponseType = typeof AuthenticationResponseSchema.type;
-
-
-//*******************************************
-// Identity Provider
-//*******************************************
-
-
-/**
- * Logs a user in the Application.
- * @category Authentication Port
- * @param email Email of the user
- * @param password Password of the user
- */
-export declare function loginUser ( email:string, password:string ): Promise<AuthenticationResponseType>;
-
-/**
- * Inits the Recover Password process for the user with the given email.
- * @category Authentication Port
- * @param email Email of the user
- */
-export declare function recoverPassword ( email:string ): Promise<void>;
-
-/**
- * Marks the user email address as validated.
- * @category Authentication Port
- * @param email Email of the user
- */
-export declare function verifyEmail ( email: string ): Promise<void>;
-
-/**
- * Logs out a user from the application
- * @category Authentication Port
- * @param token Session Token to mark as logged out
- */
-export declare function logoutUser ( token: string ): Promise<void>;
-
-/**
- * Refreshes the user sesssion given the refresh token.
- * @category Authentication Port
- * @param refreshToken Session Refresh Token
- */
-export declare function refreshToken ( refreshToken: string ): Promise<AuthenticationResponseType>;
-
-/**
- * Changes the password of the user
- * @category Authentication Port
- * @param email User Email Address
- * @param password New Password for the User
- */
-export declare function resetPassword ( email:string, password:string ): Promise<void>;
-
-/**
- * Creates a new Role in the Application in the Authentication Provider
- * @category Authentication Port
- * @param name The name of the Role To Create
- */
-export declare function createRole ( name: string ): Promise<void>;
-
-/**
- * Fetches from the Authentication Provider the list of existing Roles for the given tenant or the default one.
- * @category Authentication Port
- * @param tenant [Optional] The tenant for the role list to be retrieved
- */
-export declare function getRoles ( tenant?: string ): Promise<void>;
-
-/**
- * Deletes a Role from the Authentication Provider.
- * @category Authentication Port
- * @param name The name of the Role to Delete
- */
-export declare function deleteRole ( name: string ): Promise<void>;
-
-/**
- * Creates a new User in the Authentication Provider
- * @category Authentication Port
- * @param id Application Id of the User to create
- * @param email The Email address of the user
- * @param roles The roles to create the user with
- * @param attributes Additional Attributes to add to the auth token
- */
-export declare function createUser ( id:string, email:string, password:string, roles: string[], attributes?: Record<string, any> ): Promise<string>;
-/**
- * Creates a new User in the Authentication Provider
- * @category Authentication Port
- * @param id Provider Id of the User to create
- * @param email The Email address of the user
- * @param attributes Additional Attributes to add to the auth token
- */
-export declare function updateUser ( providerId:string, email?:string, attributes?: Record<string, any> ): Promise<string>;
-
-/**
- * Assigns a list of roles to a given user
- * @category Authentication Port
- * @param email The User Email Address
- * @param roles The Roles to assign to the user
- */
-export declare function assignUserRoles ( email:string, roles: string[]): Promise<void>;
-
-/**
- * Removes a list of roles from a given user
- * @category Authentication Port
- * @param email The User Email Address
- * @param roles The roles to remove from the user
- */
-export declare function removeUserRoles ( email:string, roles: string[]): Promise<void>;
-
-/**
- * Performs the Authorization process for a request to a resource given the user Access Token.
- * This function is the response of the `authorizeRequest` curried execution.
- * @param accessToken JWT Access Token of the request
- * @param method The HTTP method accessing the resource
- * @param uri The resource uri
- * @see {@link authorizeRequest}
- */
-export declare function authorizeRequestFunction( accessToken: string, method: string, uri: string ): Promise<void>
-
-/**
- * Curried function that will receive the routeManager as parameter and
- * return another function with the actual authorization functionality
- * @category Authentication Port
- * @param routeManager The route manager to use to perform the authorization process of the resource requested.
- * @see {@link authorizeRequestFunction}
- */
-export declare function authorizeRequest ( routeManager: RoutesAuthManagerType ): typeof authorizeRequestFunction
-
-/**
- * @category Main Types
- */
-export type AuthenticationType = {
-  name: string,
-  loginUser: typeof loginUser
-  recoverPassword: typeof recoverPassword
-  verifyEmail: typeof verifyEmail
-  logoutUser: typeof logoutUser
-  refreshToken: typeof refreshToken
-  resetPassword: typeof resetPassword
-  createRole: typeof createRole
-  getRoles: typeof getRoles
-  deleteRole: typeof deleteRole
-  createUser: typeof createUser
-  updateUser: typeof updateUser
-  assignUserRoles: typeof assignUserRoles
-  removeUserRoles: typeof removeUserRoles
-  authorizeRequest: typeof authorizeRequest
-}
-
-/**
- * @category Main Types
- */
-export type AuthenticationPort = PortEmitter & AuthenticationType & {
-  RouteManager: ( ports: Pick<Ports, 'database'|'eventstore'>, config: ClusterRoutesConfigType, eventstore?: Ports['eventstore']) => RoutesAuthManagerType
-};
-
-/**
- * Defines the concrete implementation for the Authentication Port.
- *
- * __start__ Stablishes the connection with the Authentication Provider with a Service Account with administrative
- * Priviledges that will effect all the operations.
- *
- * __stop__ Disconnects the Service Account from the Authentication Provider
- * @category Main Types
-*/
-export type AuthenticationAdapter = AuthenticationType & AdapterBase

package/src/cache.ts

@@ -1,109 +0,0 @@
-import { AdapterBase, PortEmitter } from './ports';
-
-/**
- * @category Main Types
- */
-export type CacheAdapter<T = any> = CacheType & AdapterBase<T> & {
-  flushAll: () => Promise<void>
-}
-
-/**
- * @category Main Types
- */
-export type CachePort = PortEmitter & CacheType;
-
-/**
- * @hidden
- */
-export declare function set<T extends Record<string, any>>( key: string ) : ( value: T, expirationSeconds?: number | boolean ) => Promise<T>
-/**
- * Stores a key value pair in cache
- * @category Cache Port
- * @param key The key to store in cache
- * @param value The value to store in the key. Bear in mind that the value will be JSON stringified
- * @param expirationSeconds TTL for the cache, in case of `false` passed, the cache would not expire
- */
-export declare function set<T>( key: string, value: T, expirationSeconds?: number | false ): Promise<T>
-/**
- * @category Cache Port
- * @param key
- */
-export declare function get<T>( key: string ): Promise<T>
-/**
- * @category Cache Port
- * @param key
- */
-export declare function remove( key: string ): Promise<void>
-/**
- * @category Cache Port
- * @param key
- * @param value
- */
-export declare function incrementBy( key:string, value: number ): Promise<number>
-/**
- * @category Cache Port
- * @param function
- */
-export declare function memoize<F extends Function>( func: F, expirationSeconds?: number | false ): F
-
-/**
- * @category Cache Port
- * @param pattern
- */
-export declare function keys( pattern: string ): Promise<string[]>
-
-//*******************************************
-// HASHES
-//*******************************************
-/**
- * HEXISTS
- * @category Cache Port
- * */
-export declare function hashExists( key: string, hash:string ): Promise<boolean>
-/** HGET */
-export declare function hashGet<T>( key: string, hash:string ): Promise<T>
-/**
- * HGExTALL
- * It will always return a Record<string, string>, further coerce of types must be implemented by client
- * @category Cache Port
- */
-export declare function hashGetAll( key: string ): Promise<Record<string, string>>
-/**
- * HSET
- * @category Cache Port
- * */
-export declare function hashSet<T>( key: string, hash:string, value: T ): Promise<boolean>
-/**
- * HSETNX
- * @category Cache Port
- * */
-export declare function hashSetIfNotExists<T>( key: string, hash:string, value: T ): Promise<boolean>
-/**
- * HINCRBY
- * @category Cache Port
- * */
-export declare function hashIncrementBy( key: string, hash:string, value: number ): Promise<boolean>
-/**
- * HDEL
- * @category Cache Port
- * */
-export declare function hashDel( key: string, hash:string ): Promise<boolean>
-
-/**
- * @category Main Types
- */
-export type CacheType = {
-  set: typeof set
-  get: typeof get
-  keys: typeof keys
-  memoize: typeof memoize
-  remove: typeof remove
-  incrementBy: typeof incrementBy
-  hashExists: typeof hashExists
-  hashGet: typeof hashGet
-  hashGetAll: typeof hashGetAll
-  hashSet: typeof hashSet
-  hashSetIfNotExists: typeof hashSetIfNotExists
-  hashIncrementBy: typeof hashIncrementBy
-  hashDel: typeof hashDel
-}