@pikku/core 0.6.23 → 0.6.25

package/dist/services/jwt-service.d.ts

@@ -1,3 +1,4 @@
+import { RelativeTimeInput } from '../time-utils.js';
 /**
  * Interface for handling JSON Web Tokens (JWT).
  */
@@ -8,7 +9,7 @@ export interface JWTService {
      * @param payload - The payload to encode.
      * @returns A promise that resolves to the encoded JWT.
      */
-    encode: <T extends any>(expiresIn: string, payload: T) => Promise<string>;
+    encode: <T extends any>(expiresIn: RelativeTimeInput, payload: T) => Promise<string>;
     /**
      * Decodes a JWT into its payload.
      * @param hash - The JWT to decode.

package/dist/services/local-secrets.d.ts

@@ -4,11 +4,11 @@ import { VariablesService } from './variables-service.js';
  * Service for retrieving secrets from environment variables.
  */
 export declare class LocalSecretService implements SecretService {
-    private variablesService;
+    private variables;
     /**
      * Creates an instance of LocalSecretService.
      */
-    constructor(variablesService?: VariablesService);
+    constructor(variables?: VariablesService);
     /**
      * Retrieves a secret by key.
      * @param key - The key of the secret to retrieve.

package/dist/services/local-secrets.js

@@ -3,12 +3,12 @@ import { LocalVariablesService } from './local-variables.js';
  * Service for retrieving secrets from environment variables.
  */
 export class LocalSecretService {
-    variablesService;
+    variables;
     /**
      * Creates an instance of LocalSecretService.
      */
-    constructor(variablesService = new LocalVariablesService()) {
-        this.variablesService = variablesService;
+    constructor(variables = new LocalVariablesService()) {
+        this.variables = variables;
     }
     /**
      * Retrieves a secret by key.
@@ -17,7 +17,7 @@ export class LocalSecretService {
      * @throws {Error} If the secret is not found.
      */
     async getSecretJSON(key) {
-        const value = await this.variablesService.get(key);
+        const value = await this.variables.get(key);
         if (value) {
             return JSON.parse(value);
         }
@@ -30,7 +30,7 @@ export class LocalSecretService {
      * @throws {Error} If the secret is not found.
      */
     async getSecret(key) {
-        const value = await this.variablesService.get(key);
+        const value = await this.variables.get(key);
         if (value) {
             return value;
         }

package/dist/services/user-session-service.d.ts

@@ -1,6 +1,7 @@
 import { ChannelStore } from '../channel/channel-store.js';
 import { CoreUserSession } from '../types/core.types.js';
 export interface UserSessionService<UserSession extends CoreUserSession> {
+    sessionChanged: boolean;
     setInitial(session: UserSession): void;
     set(session: UserSession): Promise<void> | void;
     clear(): Promise<void> | void;
@@ -9,6 +10,7 @@ export interface UserSessionService<UserSession extends CoreUserSession> {
 export declare class PikkuUserSessionService<UserSession extends CoreUserSession> implements UserSessionService<UserSession> {
     private channelStore?;
     private channelId?;
+    sessionChanged: boolean;
     private session;
     constructor(channelStore?: ChannelStore<unknown, unknown, UserSession> | undefined, channelId?: string | undefined);
     setInitial(session: UserSession): void;

package/dist/services/user-session-service.js

@@ -1,6 +1,7 @@
 export class PikkuUserSessionService {
     channelStore;
     channelId;
+    sessionChanged = false;
     session;
     constructor(channelStore, channelId) {
         this.channelStore = channelStore;
@@ -13,10 +14,12 @@ export class PikkuUserSessionService {
         this.session = session;
     }
     set(session) {
+        this.sessionChanged = true;
         this.session = session;
         return this.channelStore?.setUserSession(this.channelId, session);
     }
     clear() {
+        this.sessionChanged = true;
         this.session = undefined;
         return this.channelStore?.setUserSession(this.channelId, null);
     }

package/dist/time-utils.d.ts

@@ -0,0 +1,12 @@
+type TimeUnit = 'second' | 'minute' | 'hour' | 'day' | 'week' | 'year';
+export interface RelativeTimeInput {
+    value: number;
+    unit: TimeUnit;
+}
+export declare const getRelativeTimeOffset: ({ value, unit, }: RelativeTimeInput) => number;
+/**
+ * Returns a Unix timestamp (in seconds) offset from now by the given duration.
+ * e.g. value = -1 and unit = 'day' => 1 day ago => now - 86400 seconds
+ */
+export declare const getRelativeTimeOffsetFromNow: (relativeTime: RelativeTimeInput) => Date;
+export {};

package/dist/time-utils.js

@@ -0,0 +1,18 @@
+const multipliers = {
+    second: 1,
+    minute: 60,
+    hour: 60 * 60,
+    day: 60 * 60 * 24,
+    week: 60 * 60 * 24 * 7,
+    year: Math.round(365.25 * 60 * 60 * 24),
+};
+export const getRelativeTimeOffset = ({ value, unit, }) => {
+    return Math.round(value * multipliers[unit]) * 1000; // convert to milliseconds
+};
+/**
+ * Returns a Unix timestamp (in seconds) offset from now by the given duration.
+ * e.g. value = -1 and unit = 'day' => 1 day ago => now - 86400 seconds
+ */
+export const getRelativeTimeOffsetFromNow = (relativeTime) => {
+    return new Date(Date.now() + getRelativeTimeOffset(relativeTime));
+};

package/dist/types/core.types.d.ts

@@ -52,17 +52,17 @@ export interface CoreSingletonServices<Config extends CoreConfig = CoreConfig> {
     /** JWT Service */
     jwt?: JWTService;
     /** The schema library used to validate data */
-    schemaService?: SchemaService;
+    schema?: SchemaService;
     /** The core configuration for the application. */
     config: Config;
     /** The logger used by the application. */
     logger: Logger;
     /** The variable service to be used */
-    variablesService: VariablesService;
+    variables: VariablesService;
     /** The subscription service that is passed to streams */
     eventHub?: EventHubService<unknown>;
     /** SecretServce  */
-    secretService?: SecretService;
+    secrets?: SecretService;
 }
 /**
  * Represents different forms of interaction within Pikku and the outside world.
@@ -74,7 +74,7 @@ export interface PikkuInteraction {
  * A function that can wrap an interaction and be called before or after
  */
 export type PikkuMiddleware<SingletonServices extends CoreSingletonServices = CoreSingletonServices, UserSession extends CoreUserSession = CoreUserSession> = (services: SingletonServices & {
-    userSessionService: UserSessionService<UserSession>;
+    userSession: UserSessionService<UserSession>;
 }, interactions: PikkuInteraction, next: () => Promise<void>) => Promise<void>;
 /**
  * Represents the core services used by Pikku, including singleton services and the request/response interaction.
@@ -94,7 +94,7 @@ export type CreateSessionServices<SingletonServices extends CoreSingletonService
 /**
  * Defines a function type for creating config.
  */
-export type CreateConfig<Config extends CoreConfig> = (variablesService?: VariablesService) => Promise<Config>;
+export type CreateConfig<Config extends CoreConfig> = (variables?: VariablesService) => Promise<Config>;
 /**
  * Represents the documentation for a route, including summary, description, tags, and errors.
  */

package/dist/types/functions.types.d.ts

@@ -21,7 +21,7 @@ export type CoreAPIFunction<In, Out, Services extends CoreSingletonServices = Co
  */
 export type CoreAPIFunctionSessionless<In, Out, Services extends CoreSingletonServices = CoreServices & {
     channel?: PikkuChannel<unknown, Out>;
-}, Session extends CoreUserSession = CoreUserSession, Channel extends boolean = false> = (services: Services, data: In, session: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
+}, Session extends CoreUserSession = CoreUserSession, Channel extends boolean = false> = (services: Services, data: In, session?: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
 /**
  * Represents a function that checks permissions for a given API operation.
  *