@pikku/core 0.6.9 → 0.6.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pikku/core",
-  "version": "0.6.9",
+  "version": "0.6.11",
   "author": "yasser.fadl@gmail.com",
   "license": "MIT",
   "module": "dist/index.js",
@@ -10,7 +10,7 @@
     "tsc": "tsc",
     "build:esm": "tsc -b",
     "build": "yarn build:esm",
-    "ncu": "ncu",
+    "ncu": "npx npm-check-updates",
     "release": "npm run build && npm test",
     "test": "bash run-tests.sh",
     "test:watch": "bash run-tests.sh --watch",

package/src/channel/channel.types.ts

@@ -1,4 +1,4 @@
-import { EError } from '../errors/error-handler.js'
+import { PikkuError } from '../errors/error-handler.js'
 import {
   HTTPFunctionMetaInputTypes,
   PikkuHTTP,
@@ -11,7 +11,6 @@ import {
   CoreSingletonServices,
   CoreUserSession,
   CreateSessionServices,
-  MakeRequired,
 } from '../types/core.types.js'
 import { CoreAPIPermission } from '../types/functions.types.js'
 import { PikkuRequest } from '../pikku-request.js'
@@ -27,7 +26,7 @@ export type RunChannelOptions = Partial<{
 
 export type RunChannelParams<ChannelData> = {
   channelId: string
-  singletonServices: MakeRequired<CoreSingletonServices, 'eventHub'>
+  singletonServices: CoreSingletonServices
   request?: PikkuRequest<ChannelData> | PikkuHTTPAbstractRequest<ChannelData>
   response?: PikkuResponse | PikkuHTTPAbstractResponse
   http?: PikkuHTTP
@@ -67,7 +66,7 @@ export type CoreChannelConnection<
   Services extends CoreServices = CoreServices,
   Session extends CoreUserSession = CoreUserSession,
 > = (
-  services: MakeRequired<Services, 'eventHub'>,
+  services: Services,
   channel: PikkuChannel<Session, ChannelData, Out>
 ) => Promise<void>
 
@@ -76,7 +75,7 @@ export type CoreChannelDisconnection<
   Services extends CoreServices = CoreServices,
   Session extends CoreUserSession = CoreUserSession,
 > = (
-  services: MakeRequired<Services, 'eventHub'>,
+  services: Services,
   channel: PikkuChannel<Session, ChannelData, never>
 ) => Promise<void>
 
@@ -94,7 +93,7 @@ export type CoreChannelMessage<
   Services extends CoreServices = CoreServices,
   Session extends CoreUserSession = CoreUserSession,
 > = (
-  services: MakeRequired<Services, 'eventHub'>,
+  services: Services,
   channel: PikkuChannel<Session, ChannelData, Out>,
   data: In
 ) => Promise<void | Out>
@@ -110,7 +109,7 @@ export type CoreAPIChannel<
   ChannelData,
   Channel extends string,
   ChannelFunctionConnection = CoreChannelConnection<ChannelData>,
-  ChannelFunctionDisconnection = CoreChannelConnection<ChannelData>,
+  ChannelFunctionDisconnection = CoreChannelDisconnection<ChannelData>,
   ChannelFunctionDefaultMessage = CoreChannelMessage<unknown, unknown, unknown>,
   ChannelFunctionMessageRoute = CoreChannelMessage<unknown, unknown, unknown>,
   APIPermission = CoreAPIPermission<ChannelData>,
@@ -143,7 +142,7 @@ export type CoreAPIChannel<
   docs?: Partial<{
     description: string
     response: string
-    errors: Array<typeof EError>
+    errors: Array<typeof PikkuError>
     tags: string[]
   }>
 }

package/src/errors/error-handler.ts

@@ -2,9 +2,9 @@
  * Base class for custom errors.
  * @extends {Error}
  */
-export class EError extends Error {
+export class PikkuError extends Error {
   /**
-   * Creates an instance of EError.
+   * Creates an instance of PikkuError.
    * @param message - The error message.
    */
   constructor(message: string = 'An error occurred') {

package/src/errors/errors.ts

@@ -1,13 +1,13 @@
 /**
  * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
  */
-import { addError, EError } from './error-handler.js'
+import { addError, PikkuError } from './error-handler.js'
 
 /**
  * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
  * @group Error
  */
-export class BadRequestError extends EError {}
+export class BadRequestError extends PikkuError {}
 addError(BadRequestError, {
   status: 400,
   message:
@@ -18,17 +18,17 @@ addError(BadRequestError, {
  * Authentication is required and has failed or has not yet been provided.
  * @group Error
  */
-export class UnauthorizedError extends EError {}
+export class UnauthorizedError extends PikkuError {}
 /**
  * More specific error to why it's unauthorized.
  * @group Error
  */
-export class MissingSessionError extends EError {}
+export class MissingSessionError extends PikkuError {}
 /**
  * More specific error to why it's unauthorized.
  * @group Error
  */
-export class InvalidSessionError extends EError {}
+export class InvalidSessionError extends PikkuError {}
 
 addError(UnauthorizedError, {
   status: 401,
@@ -45,7 +45,7 @@ addError(InvalidSessionError, {
  * Reserved for future use, often related to digital payment or subscription services.
  * @group Error
  */
-export class PaymentRequiredError extends EError {}
+export class PaymentRequiredError extends PikkuError {}
 addError(PaymentRequiredError, {
   status: 402,
   message:
@@ -56,7 +56,7 @@ addError(PaymentRequiredError, {
  * The client does not have permission to access the requested resource.
  * @group Error
  */
-export class ForbiddenError extends EError {}
+export class ForbiddenError extends PikkuError {}
 addError(ForbiddenError, {
   status: 403,
   message:
@@ -67,7 +67,7 @@ addError(ForbiddenError, {
  * The request was made from an origin that is not permitted to access this resource.
  * @group Error
  */
-export class InvalidOriginError extends EError {}
+export class InvalidOriginError extends PikkuError {}
 addError(InvalidOriginError, {
   status: 403,
   message:
@@ -78,7 +78,7 @@ addError(InvalidOriginError, {
  * The server cannot find the requested resource.
  * @group Error
  */
-export class NotFoundError extends EError {}
+export class NotFoundError extends PikkuError {}
 /**
  * The server cannot find the requested route.
  * @group Error
@@ -92,7 +92,7 @@ addError(NotFoundError, {
  * The request method is known by the server but is not supported by the resource.
  * @group Error
  */
-export class MethodNotAllowedError extends EError {}
+export class MethodNotAllowedError extends PikkuError {}
 addError(MethodNotAllowedError, {
   status: 405,
   message:
@@ -103,7 +103,7 @@ addError(MethodNotAllowedError, {
  * The requested resource cannot produce a response matching the list of acceptable values in the request's headers.
  * @group Error
  */
-export class NotAcceptableError extends EError {}
+export class NotAcceptableError extends PikkuError {}
 addError(NotAcceptableError, {
   status: 406,
   message:
@@ -114,7 +114,7 @@ addError(NotAcceptableError, {
  * The client must authenticate itself to get the requested response.
  * @group Error
  */
-export class ProxyAuthenticationRequiredError extends EError {}
+export class ProxyAuthenticationRequiredError extends PikkuError {}
 addError(ProxyAuthenticationRequiredError, {
   status: 407,
   message: 'The client must authenticate itself to get the requested response.',
@@ -124,7 +124,7 @@ addError(ProxyAuthenticationRequiredError, {
  * The server did not receive a timely response from an upstream server.
  * @group Error
  */
-export class RequestTimeoutError extends EError {}
+export class RequestTimeoutError extends PikkuError {}
 addError(RequestTimeoutError, {
   status: 408,
   message:
@@ -135,7 +135,7 @@ addError(RequestTimeoutError, {
  * The request could not be completed due to a conflict with the current state of the target resource.
  * @group Error
  */
-export class ConflictError extends EError {}
+export class ConflictError extends PikkuError {}
 addError(ConflictError, {
   status: 409,
   message:
@@ -146,7 +146,7 @@ addError(ConflictError, {
  * The resource that is being accessed is no longer available and will not be available again.
  * @group Error
  */
-export class GoneError extends EError {}
+export class GoneError extends PikkuError {}
 addError(GoneError, {
   status: 410,
   message:
@@ -157,7 +157,7 @@ addError(GoneError, {
  * The request did not specify the length of its content, which is required by the requested resource.
  * @group Error
  */
-export class LengthRequiredError extends EError {}
+export class LengthRequiredError extends PikkuError {}
 addError(LengthRequiredError, {
   status: 411,
   message:
@@ -168,7 +168,7 @@ addError(LengthRequiredError, {
  * The server does not meet one of the preconditions that the requester put on the request.
  * @group Error
  */
-export class PreconditionFailedError extends EError {}
+export class PreconditionFailedError extends PikkuError {}
 addError(PreconditionFailedError, {
   status: 412,
   message:
@@ -179,7 +179,7 @@ addError(PreconditionFailedError, {
  * The request is larger than the server is willing or able to process.
  * @group Error
  */
-export class PayloadTooLargeError extends EError {}
+export class PayloadTooLargeError extends PikkuError {}
 addError(PayloadTooLargeError, {
   status: 413,
   message:
@@ -190,7 +190,7 @@ addError(PayloadTooLargeError, {
  * The URI requested by the client is longer than the server is willing to interpret.
  * @group Error
  */
-export class URITooLongError extends EError {}
+export class URITooLongError extends PikkuError {}
 addError(URITooLongError, {
   status: 414,
   message:
@@ -201,7 +201,7 @@ addError(URITooLongError, {
  * The server does not support the media format of the requested data.
  * @group Error
  */
-export class UnsupportedMediaTypeError extends EError {}
+export class UnsupportedMediaTypeError extends PikkuError {}
 addError(UnsupportedMediaTypeError, {
   status: 415,
   message:
@@ -212,7 +212,7 @@ addError(UnsupportedMediaTypeError, {
  * The client has asked for a portion of the file, but the server cannot supply that portion.
  * @group Error
  */
-export class RangeNotSatisfiableError extends EError {}
+export class RangeNotSatisfiableError extends PikkuError {}
 addError(RangeNotSatisfiableError, {
   status: 416,
   message:
@@ -223,7 +223,7 @@ addError(RangeNotSatisfiableError, {
  * The server cannot meet the requirements of the Expect request-header field.
  * @group Error
  */
-export class ExpectationFailedError extends EError {}
+export class ExpectationFailedError extends PikkuError {}
 addError(ExpectationFailedError, {
   status: 417,
   message:
@@ -234,7 +234,7 @@ addError(ExpectationFailedError, {
  * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
  * @group Error
  */
-export class UnprocessableContentError extends EError {}
+export class UnprocessableContentError extends PikkuError {}
 addError(UnprocessableContentError, {
   status: 422,
   message:
@@ -245,7 +245,7 @@ addError(UnprocessableContentError, {
  * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
  * @group Error
  */
-export class LockedError extends EError {}
+export class LockedError extends PikkuError {}
 addError(LockedError, {
   status: 423,
   message:
@@ -256,7 +256,7 @@ addError(LockedError, {
  * The user has sent too many requests in a given amount of time ("rate limiting").
  * @group Error
  */
-export class TooManyRequestsError extends EError {}
+export class TooManyRequestsError extends PikkuError {}
 addError(TooManyRequestsError, {
   status: 429,
   message:
@@ -267,7 +267,7 @@ addError(TooManyRequestsError, {
  * A generic error message, given when no more specific message is suitable.
  * @group Error
  */
-export class InternalServerError extends EError {}
+export class InternalServerError extends PikkuError {}
 addError(InternalServerError, {
   status: 500,
   message:
@@ -278,7 +278,7 @@ addError(InternalServerError, {
  * The server does not recognize the request method and cannot support it.
  * @group Error
  */
-export class NotImplementedError extends EError {}
+export class NotImplementedError extends PikkuError {}
 addError(NotImplementedError, {
   status: 501,
   message:
@@ -289,7 +289,7 @@ addError(NotImplementedError, {
  * The server was acting as a gateway or proxy and received an invalid response from the upstream server.
  * @group Error
  */
-export class BadGatewayError extends EError {}
+export class BadGatewayError extends PikkuError {}
 addError(BadGatewayError, {
   status: 502,
   message:
@@ -300,7 +300,7 @@ addError(BadGatewayError, {
  * The server is currently unavailable (overloaded or down).
  * @group Error
  */
-export class ServiceUnavailableError extends EError {}
+export class ServiceUnavailableError extends PikkuError {}
 addError(ServiceUnavailableError, {
   status: 503,
   message: 'The server is currently unavailable (overloaded or down).',
@@ -310,7 +310,7 @@ addError(ServiceUnavailableError, {
  * The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
  * @group Error
  */
-export class GatewayTimeoutError extends EError {}
+export class GatewayTimeoutError extends PikkuError {}
 addError(GatewayTimeoutError, {
   status: 504,
   message:
@@ -321,7 +321,7 @@ addError(GatewayTimeoutError, {
  * The server does not support the HTTP protocol version used in the request.
  * @group Error
  */
-export class HTTPVersionNotSupportedError extends EError {}
+export class HTTPVersionNotSupportedError extends PikkuError {}
 addError(HTTPVersionNotSupportedError, {
   status: 505,
   message:
@@ -332,7 +332,7 @@ addError(HTTPVersionNotSupportedError, {
  * The server took too long to complete the request, reaching the maximum compute time allowed.
  * @group Error
  */
-export class MaxComputeTimeReachedError extends EError {}
+export class MaxComputeTimeReachedError extends PikkuError {}
 addError(MaxComputeTimeReachedError, {
   status: 524,
   message:

package/src/http/http-routes.types.ts

@@ -1,4 +1,4 @@
-import { EError } from '../errors/error-handler.js'
+import { PikkuError } from '../errors/error-handler.js'
 import {
   APIDocs,
   CoreServices,
@@ -71,7 +71,7 @@ export type CoreHTTPFunction = {
   docs?: Partial<{
     description: string
     response: string
-    errors: Array<typeof EError>
+    errors: Array<typeof PikkuError>
     tags: string[]
   }>
 }

package/src/scheduler/scheduler-runner.ts

@@ -101,7 +101,7 @@ export async function runScheduledTask<
     }
 
     singletonServices.logger.info(
-      `Running schedule task: ${name} | schedule: ${task.schedule}}`
+      `Running schedule task: ${name} | schedule: ${task.schedule}`
     )
 
     let allServices = singletonServices

package/src/types/core.types.ts

@@ -60,16 +60,15 @@ export type CoreConfig<Config extends Record<string, unknown> = {}> = {
 /**
  * Represents a core user session, which can be extended for more specific session information.
  */
-export type CoreUserSession<UserSession = unknown> = UserSession
+export interface CoreUserSession {}
 
 /**
  * Interface for core singleton services provided by Pikku.
  */
-export type CoreSingletonServices<
+export interface CoreSingletonServices<
   Config extends CoreConfig = CoreConfig,
   UserSession extends CoreUserSession = CoreUserSession,
-  UserServices extends Record<string, unknown> = {},
-> = {
+> {
   /** The http permission service used for authorization (optional). */
   enforceHTTPAccess?: enforceHTTPAccess
   /** The channel permission service used by the application (optional). */
@@ -90,7 +89,7 @@ export type CoreSingletonServices<
   eventHub?: EventHubService<unknown>
   /** SecretServce  */
   secretService?: SecretService
-} & UserServices
+}
 
 /**
  * Represents different forms of interaction within Pikku and the outside world.