@pikku/core 0.7.0 → 0.7.1

package/dist/http/http-routes.types.d.ts

@@ -1,179 +0,0 @@
-import type { SerializeOptions } from 'cookie';
-import type { PikkuError } from '../errors/error-handler.js';
-import type { APIDocs, CoreServices, CoreSingletonServices, CoreUserSession, CreateSessionServices, PikkuMiddleware } from '../types/core.types.js';
-import type { CoreAPIFunction, CoreAPIFunctionSessionless, CoreAPIPermission, CorePermissionGroup } from '../function/functions.types.js';
-type ExtractRouteParams<S extends string> = S extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractRouteParams<`/${Rest}`> : S extends `${string}:${infer Param}` ? Param : never;
-export type AssertRouteParams<In, Route extends string> = ExtractRouteParams<Route> extends keyof In ? unknown : ['Error: Route parameters', ExtractRouteParams<Route>, 'not in', keyof In];
-export type RunRouteOptions = Partial<{
-    skipUserSession: boolean;
-    respondWith404: boolean;
-    logWarningsForStatusCodes: number[];
-    coerceDataFromSchema: boolean;
-    bubbleErrors: boolean;
-    generateRequestId: () => string;
-}>;
-export type RunRouteParams = {
-    singletonServices: CoreSingletonServices;
-    createSessionServices: CreateSessionServices<CoreSingletonServices, CoreServices<CoreSingletonServices>, CoreUserSession>;
-};
-/**
- * Represents the HTTP methods supported for API routes.
- */
-export type HTTPMethod = 'post' | 'get' | 'delete' | 'patch' | 'head' | 'put' | 'options';
-/**
- * Represents an API route without a function, including metadata such as content type, route, and timeout settings.
- */
-export type CoreHTTPFunction = {
-    contentType?: 'xml' | 'json';
-    route: string;
-    eventChannel?: false;
-    returnsJSON?: false;
-    timeout?: number;
-    docs?: Partial<{
-        description: string;
-        response: string;
-        errors: Array<typeof PikkuError>;
-        tags: string[];
-    }>;
-};
-/**
- * Represents a http interaction within Pikku, including a request and response.
- */
-export interface PikkuHTTP {
-    request?: PikkuHTTPRequest;
-    response?: PikkuHTTPResponse;
-}
-/**
- * Represents request headers as either a record or a function to get headers by name.
- */
-export type RequestHeaders = Record<string, string | string[] | undefined> | ((headerName: string) => string | string[] | undefined);
-/**
- * Represents a query object for Pikku, where each key can be a string, a value, or an array of values.
- */
-export type PikkuQuery<T = Record<string, string | undefined>> = Record<string, string | T | null | Array<T | null>>;
-/**
- * Represents a core API route, which can have different configurations depending on whether it requires authentication and permissions.
- *
- * @template In - The input type.
- * @template Out - The output type.
- * @template R - The route string type.
- * @template APIFunction - The API function type, defaults to `CoreAPIFunction`.
- * @template APIFunctionSessionless - The sessionless API function type, defaults to `CoreAPIFunctionSessionless`.
- * @template APIPermission - The permission function type, defaults to `CoreAPIPermission`.
- */
-export type CoreHTTPFunctionRoute<In, Out, R extends string, APIFunction = CoreAPIFunction<In, Out>, APIFunctionSessionless = CoreAPIFunctionSessionless<In, Out>, APIPermission = CoreAPIPermission<In>, APIMiddleware = PikkuMiddleware> = (CoreHTTPFunction & {
-    route: R;
-    method: HTTPMethod;
-    func: APIFunction;
-    permissions?: CorePermissionGroup<APIPermission>;
-    auth?: true;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-    sse?: undefined;
-}) | (CoreHTTPFunction & {
-    route: R;
-    method: HTTPMethod;
-    func: APIFunctionSessionless;
-    permissions?: undefined;
-    auth?: false;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-    sse?: undefined;
-}) | (CoreHTTPFunction & {
-    route: R;
-    method: 'get';
-    func: APIFunction;
-    permissions?: CorePermissionGroup<APIPermission>;
-    auth?: true;
-    sse?: boolean;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-}) | (CoreHTTPFunction & {
-    route: R;
-    method: 'get';
-    func: APIFunctionSessionless;
-    permissions?: undefined;
-    auth?: false;
-    sse?: boolean;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-}) | (CoreHTTPFunction & {
-    route: R;
-    method: 'post';
-    func: APIFunction;
-    permissions?: CorePermissionGroup<APIPermission>;
-    auth?: true;
-    query?: Array<keyof In>;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-    sse?: undefined;
-}) | (CoreHTTPFunction & {
-    route: R;
-    method: 'post';
-    func: APIFunctionSessionless;
-    permissions?: undefined;
-    auth?: false;
-    query?: Array<keyof In>;
-    tags?: string[];
-    middleware?: APIMiddleware[];
-    sse?: undefined;
-});
-/**
- * Represents an array of core API routes.
- */
-export type CoreHTTPFunctionRoutes = Array<CoreHTTPFunctionRoute<any, any, string>>;
-/**
- * Represents the input types for route metadata, including parameters, query, and body types.
- */
-export type HTTPFunctionMetaInputTypes = {
-    params?: string;
-    query?: string;
-    body?: string;
-};
-/**
- * Represents metadata for a set of routes, including route details, methods, input/output types, and documentation.
- */
-export type HTTPRoutesMeta = Array<{
-    route: string;
-    method: HTTPMethod;
-    params?: string[];
-    query?: string[];
-    input: string | null;
-    output: string | null;
-    inputTypes?: HTTPFunctionMetaInputTypes;
-    docs?: APIDocs;
-    tags?: string[];
-    sse?: true;
-}>;
-export type HTTPFunctionsMeta = Array<{
-    name: string;
-    inputs: string[] | null;
-    outputs: string[] | null;
-}>;
-export type HTTPRouteMiddleware = {
-    route: string;
-    middleware: PikkuMiddleware[];
-};
-export interface PikkuHTTPRequest<In = unknown> {
-    method(): HTTPMethod;
-    path(): string;
-    data(): Promise<In>;
-    json(): Promise<unknown>;
-    arrayBuffer(): Promise<ArrayBuffer>;
-    header(headerName: string): string | null;
-    cookie(name?: string): string | null;
-    params(): Partial<Record<string, string | string[]>>;
-    setParams(params: Record<string, string | string[] | undefined>): void;
-    query(): PikkuQuery;
-}
-export interface PikkuHTTPResponse {
-    status(code: number): this;
-    cookie(name: string, value: string | null, options: SerializeOptions): this;
-    header(name: string, value: string | string[]): this;
-    arrayBuffer(data: ArrayBuffer | ArrayBufferView | Blob | string | FormData | URLSearchParams | ReadableStream): this;
-    json(data: unknown): this;
-    redirect(location: string, status?: number): this;
-    close?: () => void;
-    setMode?: (mode: 'stream') => void;
-}
-export {};

package/dist/http/http-routes.types.js

@@ -1 +0,0 @@
-export {};

package/dist/http/pikku-http-request.d.ts

@@ -1,56 +0,0 @@
-import { PikkuRequest } from '../pikku-request.js';
-import { HTTPMethod, PikkuQuery } from './http-routes.types.js';
-/**
- * Abstract class representing a pikku request.
- * @template In - The type of the request body.
- * @group RequestResponse
- */
-export declare class PikkuHTTPRequest<In = unknown> extends PikkuRequest<In> {
-    private request;
-    private _params;
-    private url;
-    constructor(request: Request);
-    method(): HTTPMethod;
-    path(): string;
-    /**
-     * Retrieves the request body.
-     * @returns A promise that resolves to the request body.
-     */
-    json(): Promise<In>;
-    /**
-     * Retrieves the raw request body as a Buffer.
-     * @returns A promise that resolves to the raw request body.
-     */
-    arrayBuffer(): Promise<ArrayBuffer>;
-    /**
-     * Retrieves the value of a specific header.
-     * @param headerName - The name of the header to retrieve.
-     * @returns The value of the header, or undefined if the header is not found.
-     */
-    header(headerName: string): string | null;
-    /**
-     * Retrieves the cookies from the request.
-     * @returns An object containing the cookies.
-     */
-    cookies(): Partial<Record<string, string>>;
-    /**
-     * Retrieves the request parameters.
-     * @returns An object containing the request parameters.
-     */
-    params(): Partial<Record<string, string | string[]>>;
-    /**
-     * Sets the request parameters.
-     * @param params - An object containing the request parameters to set.
-     */
-    setParams(params: Record<string, string | string[] | undefined>): void;
-    /**
-     * Retrieves the query parameters from the request.
-     * @returns An object containing the query parameters.
-     */
-    query(): PikkuQuery;
-    /**
-     * Retrieves the combined data from the request, including parameters, query, and body.
-     * @returns A promise that resolves to an object containing the combined data.
-     */
-    getData(): Promise<In>;
-}

package/dist/http/pikku-http-request.js

@@ -1,95 +0,0 @@
-import { parse as parseQuery } from 'picoquery';
-import { parse as parseCookie } from 'cookie';
-import { PikkuRequest } from '../pikku-request.js';
-/**
- * Abstract class representing a pikku request.
- * @template In - The type of the request body.
- * @group RequestResponse
- */
-export class PikkuHTTPRequest extends PikkuRequest {
-    request;
-    _params = {};
-    url;
-    constructor(request) {
-        super();
-        this.request = request;
-        this.url = new URL(request.url);
-    }
-    method() {
-        return this.request.method.toLowerCase();
-    }
-    path() {
-        return this.url.pathname;
-    }
-    /**
-     * Retrieves the request body.
-     * @returns A promise that resolves to the request body.
-     */
-    json() {
-        return this.request.json();
-    }
-    /**
-     * Retrieves the raw request body as a Buffer.
-     * @returns A promise that resolves to the raw request body.
-     */
-    arrayBuffer() {
-        return this.request.arrayBuffer();
-    }
-    /**
-     * Retrieves the value of a specific header.
-     * @param headerName - The name of the header to retrieve.
-     * @returns The value of the header, or undefined if the header is not found.
-     */
-    header(headerName) {
-        return this.request.headers.get(headerName.toLowerCase());
-    }
-    /**
-     * Retrieves the cookies from the request.
-     * @returns An object containing the cookies.
-     */
-    cookies() {
-        const cookieHeader = this.header('cookie');
-        if (cookieHeader) {
-            return parseCookie(cookieHeader);
-        }
-        return {};
-    }
-    /**
-     * Retrieves the request parameters.
-     * @returns An object containing the request parameters.
-     */
-    params() {
-        return this._params;
-    }
-    /**
-     * Sets the request parameters.
-     * @param params - An object containing the request parameters to set.
-     */
-    setParams(params) {
-        this._params = params;
-    }
-    /**
-     * Retrieves the query parameters from the request.
-     * @returns An object containing the query parameters.
-     */
-    query() {
-        return parseQuery(this.url.searchParams.toString());
-    }
-    /**
-     * Retrieves the combined data from the request, including parameters, query, and body.
-     * @returns A promise that resolves to an object containing the combined data.
-     */
-    async getData() {
-        let body = {};
-        try {
-            body = await this.json();
-        }
-        catch (e) { }
-        return {
-            ...this.params(),
-            ...this.query(),
-            // TODO: If body isn't an object, we should insert it as the word...
-            ...body,
-        };
-    }
-}

package/dist/http/pikku-http-response.d.ts

@@ -1,13 +0,0 @@
-export declare class PikkuHTTPResponse {
-    #private;
-    status(code: number): this;
-    cookie(name: string, value: string, flags: any): this;
-    header(name: string, value: string | string[]): this;
-    arrayBuffer(data: XMLHttpRequestBodyInit): this;
-    json(data: unknown): this;
-    text(content: string): this;
-    html(content: string): this;
-    body(body: BodyInit): this;
-    redirect(location: string, status?: number): this;
-    toResponse(args?: Record<string, any>): Response;
-}

package/dist/http/pikku-http-response.js

@@ -1,60 +0,0 @@
-export class PikkuHTTPResponse {
-    #statusCode = 200;
-    #headers = new Headers();
-    #body = null;
-    status(code) {
-        this.#statusCode = code;
-        return this;
-    }
-    cookie(name, value, flags) {
-        // TODO
-        return this;
-    }
-    header(name, value) {
-        this.#headers.delete(name);
-        if (Array.isArray(value)) {
-            value.forEach((v) => this.#headers.append(name, v));
-        }
-        else {
-            this.#headers.set(name, value);
-        }
-        return this;
-    }
-    arrayBuffer(data) {
-        this.#body = data;
-        this.header('Content-Type', 'application/octet-stream');
-        return this;
-    }
-    json(data) {
-        this.#body = JSON.stringify(data);
-        this.header('Content-Type', 'application/json');
-        return this;
-    }
-    text(content) {
-        this.#body = content;
-        this.header('Content-Type', 'text/plain');
-        return this;
-    }
-    html(content) {
-        this.#body = content;
-        this.header('Content-Type', 'text/html');
-        return this;
-    }
-    body(body) {
-        this.#body = body;
-        return this;
-    }
-    redirect(location, status = 302) {
-        this.#statusCode = status;
-        this.header('Location', location);
-        this.html(`Redirecting to <a href="${location}">${location}</a>`);
-        return this;
-    }
-    toResponse(args) {
-        return new Response(this.#body, {
-            ...args,
-            status: this.#statusCode,
-            headers: this.#headers,
-        });
-    }
-}

package/dist/parse-relative-time-offset.d.ts

@@ -1,12 +0,0 @@
-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/parse-relative-time-offset.js

@@ -1,20 +0,0 @@
-export const getRelativeTimeOffset = ({ value, unit }) => {
-    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),
-    };
-    return Math.round(value * multipliers[unit]);
-};
-/**
- * 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) => {
-    const now = Math.floor(Date.now() / 1000);
-    console.log(getRelativeTimeOffset(relativeTime), relativeTime, now);
-    return new Date(now + getRelativeTimeOffset(relativeTime));
-};

package/dist/pikku-func.d.ts

@@ -1,12 +0,0 @@
-import { CoreServices, CoreSingletonServices, CoreUserSession } from "./types/core.types.js";
-import { CoreAPIFunction, CoreAPIFunctionSessionless, CorePermissionGroup } from "./types/functions.types.js";
-export declare const getFunctionName: (func: CoreAPIFunction<any, any> | CoreAPIFunctionSessionless<any, any>) => string;
-export declare const runPikkuFuncDirectly: <In, Out>(funcName: string, allServices: CoreServices, data: In, session?: CoreUserSession) => Promise<Out>;
-export declare const runPikkuFunc: <In = any, Out = any>(funcName: string, { singletonServices, getAllServices, data, session, permissions, coerceDataFromSchema }: {
-    singletonServices: CoreSingletonServices;
-    getAllServices: () => Promise<CoreServices> | CoreServices;
-    data: In;
-    session?: CoreUserSession;
-    permissions?: CorePermissionGroup;
-    coerceDataFromSchema?: boolean;
-}) => Promise<Out>;

package/dist/pikku-func.js

@@ -1,39 +0,0 @@
-import { ForbiddenError } from "./errors/errors.js";
-import { verifyPermissions } from "./permissions.js";
-import { pikkuState } from "./pikku-state.js";
-import { coerceTopLevelDataFromSchema, validateSchema } from "./schema.js";
-export const getFunctionName = (func) => {
-    const funcName = pikkuState('functions', 'functionToName').get(func);
-    if (!funcName) {
-        throw new Error(`Function not found: ${funcName}`);
-    }
-    return funcName;
-};
-export const runPikkuFuncDirectly = async (funcName, allServices, data, session) => {
-    const func = pikkuState('functions', 'nameToFunction').get(funcName);
-    if (!func) {
-        throw new Error(`Function not found: ${funcName}`);
-    }
-    return await func(allServices, data, session);
-};
-export const runPikkuFunc = async (funcName, { singletonServices, getAllServices, data, session, permissions, coerceDataFromSchema }) => {
-    const func = pikkuState('functions', 'nameToFunction').get(funcName);
-    if (!func) {
-        throw new Error(`Function not found: ${funcName}`);
-    }
-    const funcMeta = pikkuState('functions', 'meta')[funcName];
-    const schemaName = funcMeta.schemaName;
-    // Validate request data against the defined schema, if any
-    await validateSchema(singletonServices.logger, singletonServices.schema, schemaName, data);
-    // Coerce (top level) query string parameters or date objects if specified by the schema
-    if (coerceDataFromSchema && schemaName) {
-        coerceTopLevelDataFromSchema(schemaName, data);
-    }
-    const allServices = await getAllServices();
-    // Execute permission checks
-    const permissioned = await verifyPermissions(permissions, allServices, data, session);
-    if (permissioned === false) {
-        throw new ForbiddenError('Permission denied');
-    }
-    return await func(allServices, data, session);
-};

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

@@ -1,37 +0,0 @@
-import { PikkuChannel } from '../channel/channel.types.js';
-import type { CoreServices, CoreSingletonServices, CoreUserSession } from './core.types.js';
-/**
- * Represents a core API function that performs an operation using core services and a user session.
- *
- * @template In - The input type.
- * @template Out - The output type.
- * @template Services - The services type, defaults to `CoreServices`.
- * @template Session - The session type, defaults to `CoreUserSession`.
- */
-export type CoreAPIFunction<In, Out, Channel extends boolean = false, Services extends CoreSingletonServices = CoreServices & (Channel extends true ? {
-    channel: PikkuChannel<unknown, Out>;
-} : {
-    channel?: PikkuChannel<unknown, Out> | undefined;
-}), Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session: Session) => Channel extends true ? Promise<Out> | Promise<void> : Promise<Out>;
-/**
- * Represents a core API function that can be used without a session.
- *
- * @template In - The input type.
- * @template Out - The output type.
- * @template Services - The services type, defaults to `CoreServices`.
- * @template Session - The session type, defaults to `CoreUserSession`.
- */
-export type CoreAPIFunctionSessionless<In, Out, Channel extends boolean = false, Services extends CoreSingletonServices = CoreServices & (Channel extends true ? {
-    channel: PikkuChannel<unknown, Out>;
-} : {
-    channel?: PikkuChannel<unknown, Out> | undefined;
-}), Session extends CoreUserSession = CoreUserSession> = (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.
- *
- * @template In - The input type.
- * @template Services - The services type, defaults to `CoreServices`.
- * @template Session - The session type, defaults to `CoreUserSession`.
- */
-export type CoreAPIPermission<In = any, Services extends CoreSingletonServices = CoreServices, Session extends CoreUserSession = CoreUserSession> = (services: Services, data: In, session?: Session) => Promise<boolean>;
-export type CorePermissionGroup<APIPermission = CoreAPIPermission<any>> = Record<string, APIPermission | APIPermission[]> | undefined;

package/dist/types/functions.types.js

@@ -1 +0,0 @@
-export {};