@carlonicora/nextjs-jsonapi 1.5.0 → 1.7.0

package/dist/notification.interface-agcMYCkg.d.mts

@@ -0,0 +1,228 @@
+import { LucideIcon } from 'lucide-react';
+
+interface JsonApiHydratedDataInterface {
+    jsonApi: any;
+    included: any[];
+    allData?: any[];
+}
+
+interface ApiDataInterface {
+    get included(): any[];
+    get type(): string;
+    get id(): string;
+    get createdAt(): Date;
+    get updatedAt(): Date;
+    get self(): string | undefined;
+    get jsonApi(): any;
+    generateApiUrl(params?: any): string;
+    dehydrate(): JsonApiHydratedDataInterface;
+    rehydrate(data: JsonApiHydratedDataInterface): this;
+    createJsonApi(data: any): any;
+}
+
+type GetterKeys<T> = {
+    [K in keyof T]: T[K] extends () => any ? never : K;
+}[keyof T];
+type FieldSelector<T> = {
+    type: string;
+    fields: ReadonlyArray<GetterKeys<T>>;
+};
+declare function createJsonApiInclusion<T>(dataType: string, fields: ReadonlyArray<GetterKeys<T>>): FieldSelector<T>;
+
+type ApiRequestDataTypeInterface = {
+    name: string;
+    cache?: string;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+    model: new () => any;
+};
+
+/**
+ * Permission actions
+ */
+declare enum Action {
+    Read = "read",
+    Create = "create",
+    Update = "update",
+    Delete = "delete"
+}
+/**
+ * Generic permission check type.
+ * Can be a boolean or a function that checks permissions dynamically.
+ * @template T - The data type being checked
+ * @template U - The user type (defaults to PermissionUser)
+ */
+type PermissionCheck<T, U = PermissionUser> = boolean | ((user?: U | string, data?: T) => boolean);
+/**
+ * Page URL configuration for modules
+ */
+type PageUrl = {
+    pageUrl?: string;
+};
+/**
+ * Module permission definition wrapper
+ */
+type ModulePermissionDefinition<T> = {
+    interface: T;
+};
+/**
+ * Base module definition
+ */
+type ModuleDefinition = {
+    pageUrl?: string;
+    name: string;
+    model: any;
+    feature?: string;
+    moduleId?: string;
+};
+/**
+ * Permission configuration for a module.
+ * Can be a boolean (allow/deny all) or a string path for dynamic checks.
+ */
+interface PermissionConfig {
+    create: boolean | string;
+    read: boolean | string;
+    update: boolean | string;
+    delete: boolean | string;
+}
+/**
+ * Generic interface for a module that has permissions.
+ * Apps should ensure their Module class implements this.
+ */
+interface PermissionModule {
+    id: string;
+    permissions: PermissionConfig;
+}
+/**
+ * Generic interface for a user that has modules with permissions.
+ * Apps should ensure their User class implements this.
+ */
+interface PermissionUser {
+    id: string;
+    modules: PermissionModule[];
+}
+/**
+ * Module definition with permissions - extends ApiRequestDataTypeInterface
+ */
+type ModuleWithPermissions = ApiRequestDataTypeInterface & {
+    pageUrl?: string;
+    feature?: string;
+    moduleId?: string;
+    icon?: LucideIcon;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+};
+/**
+ * Factory type for creating module definitions
+ */
+type ModuleFactory = (params: {
+    pageUrl?: string;
+    name: string;
+    cache?: string | "days" | "default" | "hours" | "max" | "minutes" | "seconds" | "weeks";
+    model: any;
+    feature?: string;
+    moduleId?: string;
+    icon?: LucideIcon;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+}) => ModuleWithPermissions;
+
+interface ModuleInterface extends ApiDataInterface {
+    get name(): string;
+    get isCore(): boolean;
+    get permissions(): {
+        create: boolean | string;
+        read: boolean | string;
+        update: boolean | string;
+        delete: boolean | string;
+    };
+}
+
+interface FeatureInterface extends ApiDataInterface {
+    get name(): string;
+    get isProduction(): boolean;
+    get modules(): ModuleInterface[];
+}
+
+type CompanyInput = {
+    id: string;
+    name?: string;
+    logo?: string;
+    configurations?: any;
+    license?: string;
+    privateKey?: string;
+    featureIds?: string[];
+    moduleIds?: string[];
+};
+interface CompanyInterface extends ApiDataInterface {
+    get name(): string;
+    get configurations(): any;
+    get logo(): string | undefined;
+    get logoUrl(): string | undefined;
+    get licenseExpirationDate(): Date | undefined;
+    get features(): FeatureInterface[];
+    get modules(): ModuleInterface[];
+}
+
+type RoleInput = {
+    id: string;
+    name: string;
+    description?: string;
+};
+interface RoleInterface extends ApiDataInterface {
+    get name(): string;
+    get description(): string;
+    get isSelectable(): boolean;
+    get requiredFeature(): FeatureInterface | undefined;
+}
+
+type UserInput = {
+    id: string;
+    email?: string | undefined | null;
+    name?: string;
+    title?: string;
+    bio?: string;
+    password?: string | undefined;
+    roleIds?: string[];
+    sendInvitationEmail?: boolean;
+    companyId?: string;
+    adminCreated?: boolean;
+    avatar?: string;
+    phone?: string;
+    rate?: number;
+};
+interface UserInterface extends ApiDataInterface {
+    get email(): string;
+    get name(): string;
+    get title(): string;
+    get bio(): string;
+    get avatar(): string | undefined;
+    get avatarUrl(): string | undefined;
+    get phone(): string | undefined;
+    get rate(): number | undefined;
+    get isActivated(): boolean;
+    get isDeleted(): boolean;
+    get lastLogin(): Date | undefined;
+    get relevance(): number | undefined;
+    get roles(): RoleInterface[];
+    get company(): CompanyInterface | undefined;
+    get modules(): ModuleInterface[];
+}
+
+type NotificationInput = {
+    id: string;
+    isRead: boolean;
+};
+interface NotificationInterface extends ApiDataInterface {
+    get notificationType(): string;
+    get isRead(): boolean;
+    get actor(): UserInterface | undefined;
+}
+
+export { type ApiDataInterface as A, type CompanyInput as C, type FieldSelector as F, type GetterKeys as G, type JsonApiHydratedDataInterface as J, type ModuleWithPermissions as M, type NotificationInterface as N, type PermissionCheck as P, type RoleInput as R, type UserInterface as U, type ApiRequestDataTypeInterface as a, Action as b, createJsonApiInclusion as c, type PageUrl as d, type ModulePermissionDefinition as e, type ModuleDefinition as f, type PermissionConfig as g, type PermissionModule as h, type PermissionUser as i, type ModuleFactory as j, type CompanyInterface as k, type FeatureInterface as l, type ModuleInterface as m, type NotificationInput as n, type RoleInterface as o, type UserInput as p };

package/dist/notification.interface-agcMYCkg.d.ts

@@ -0,0 +1,228 @@
+import { LucideIcon } from 'lucide-react';
+
+interface JsonApiHydratedDataInterface {
+    jsonApi: any;
+    included: any[];
+    allData?: any[];
+}
+
+interface ApiDataInterface {
+    get included(): any[];
+    get type(): string;
+    get id(): string;
+    get createdAt(): Date;
+    get updatedAt(): Date;
+    get self(): string | undefined;
+    get jsonApi(): any;
+    generateApiUrl(params?: any): string;
+    dehydrate(): JsonApiHydratedDataInterface;
+    rehydrate(data: JsonApiHydratedDataInterface): this;
+    createJsonApi(data: any): any;
+}
+
+type GetterKeys<T> = {
+    [K in keyof T]: T[K] extends () => any ? never : K;
+}[keyof T];
+type FieldSelector<T> = {
+    type: string;
+    fields: ReadonlyArray<GetterKeys<T>>;
+};
+declare function createJsonApiInclusion<T>(dataType: string, fields: ReadonlyArray<GetterKeys<T>>): FieldSelector<T>;
+
+type ApiRequestDataTypeInterface = {
+    name: string;
+    cache?: string;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+    model: new () => any;
+};
+
+/**
+ * Permission actions
+ */
+declare enum Action {
+    Read = "read",
+    Create = "create",
+    Update = "update",
+    Delete = "delete"
+}
+/**
+ * Generic permission check type.
+ * Can be a boolean or a function that checks permissions dynamically.
+ * @template T - The data type being checked
+ * @template U - The user type (defaults to PermissionUser)
+ */
+type PermissionCheck<T, U = PermissionUser> = boolean | ((user?: U | string, data?: T) => boolean);
+/**
+ * Page URL configuration for modules
+ */
+type PageUrl = {
+    pageUrl?: string;
+};
+/**
+ * Module permission definition wrapper
+ */
+type ModulePermissionDefinition<T> = {
+    interface: T;
+};
+/**
+ * Base module definition
+ */
+type ModuleDefinition = {
+    pageUrl?: string;
+    name: string;
+    model: any;
+    feature?: string;
+    moduleId?: string;
+};
+/**
+ * Permission configuration for a module.
+ * Can be a boolean (allow/deny all) or a string path for dynamic checks.
+ */
+interface PermissionConfig {
+    create: boolean | string;
+    read: boolean | string;
+    update: boolean | string;
+    delete: boolean | string;
+}
+/**
+ * Generic interface for a module that has permissions.
+ * Apps should ensure their Module class implements this.
+ */
+interface PermissionModule {
+    id: string;
+    permissions: PermissionConfig;
+}
+/**
+ * Generic interface for a user that has modules with permissions.
+ * Apps should ensure their User class implements this.
+ */
+interface PermissionUser {
+    id: string;
+    modules: PermissionModule[];
+}
+/**
+ * Module definition with permissions - extends ApiRequestDataTypeInterface
+ */
+type ModuleWithPermissions = ApiRequestDataTypeInterface & {
+    pageUrl?: string;
+    feature?: string;
+    moduleId?: string;
+    icon?: LucideIcon;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+};
+/**
+ * Factory type for creating module definitions
+ */
+type ModuleFactory = (params: {
+    pageUrl?: string;
+    name: string;
+    cache?: string | "days" | "default" | "hours" | "max" | "minutes" | "seconds" | "weeks";
+    model: any;
+    feature?: string;
+    moduleId?: string;
+    icon?: LucideIcon;
+    inclusions?: Record<string, {
+        types?: string[];
+        fields?: FieldSelector<any>[];
+    }>;
+}) => ModuleWithPermissions;
+
+interface ModuleInterface extends ApiDataInterface {
+    get name(): string;
+    get isCore(): boolean;
+    get permissions(): {
+        create: boolean | string;
+        read: boolean | string;
+        update: boolean | string;
+        delete: boolean | string;
+    };
+}
+
+interface FeatureInterface extends ApiDataInterface {
+    get name(): string;
+    get isProduction(): boolean;
+    get modules(): ModuleInterface[];
+}
+
+type CompanyInput = {
+    id: string;
+    name?: string;
+    logo?: string;
+    configurations?: any;
+    license?: string;
+    privateKey?: string;
+    featureIds?: string[];
+    moduleIds?: string[];
+};
+interface CompanyInterface extends ApiDataInterface {
+    get name(): string;
+    get configurations(): any;
+    get logo(): string | undefined;
+    get logoUrl(): string | undefined;
+    get licenseExpirationDate(): Date | undefined;
+    get features(): FeatureInterface[];
+    get modules(): ModuleInterface[];
+}
+
+type RoleInput = {
+    id: string;
+    name: string;
+    description?: string;
+};
+interface RoleInterface extends ApiDataInterface {
+    get name(): string;
+    get description(): string;
+    get isSelectable(): boolean;
+    get requiredFeature(): FeatureInterface | undefined;
+}
+
+type UserInput = {
+    id: string;
+    email?: string | undefined | null;
+    name?: string;
+    title?: string;
+    bio?: string;
+    password?: string | undefined;
+    roleIds?: string[];
+    sendInvitationEmail?: boolean;
+    companyId?: string;
+    adminCreated?: boolean;
+    avatar?: string;
+    phone?: string;
+    rate?: number;
+};
+interface UserInterface extends ApiDataInterface {
+    get email(): string;
+    get name(): string;
+    get title(): string;
+    get bio(): string;
+    get avatar(): string | undefined;
+    get avatarUrl(): string | undefined;
+    get phone(): string | undefined;
+    get rate(): number | undefined;
+    get isActivated(): boolean;
+    get isDeleted(): boolean;
+    get lastLogin(): Date | undefined;
+    get relevance(): number | undefined;
+    get roles(): RoleInterface[];
+    get company(): CompanyInterface | undefined;
+    get modules(): ModuleInterface[];
+}
+
+type NotificationInput = {
+    id: string;
+    isRead: boolean;
+};
+interface NotificationInterface extends ApiDataInterface {
+    get notificationType(): string;
+    get isRead(): boolean;
+    get actor(): UserInterface | undefined;
+}
+
+export { type ApiDataInterface as A, type CompanyInput as C, type FieldSelector as F, type GetterKeys as G, type JsonApiHydratedDataInterface as J, type ModuleWithPermissions as M, type NotificationInterface as N, type PermissionCheck as P, type RoleInput as R, type UserInterface as U, type ApiRequestDataTypeInterface as a, Action as b, createJsonApiInclusion as c, type PageUrl as d, type ModulePermissionDefinition as e, type ModuleDefinition as f, type PermissionConfig as g, type PermissionModule as h, type PermissionUser as i, type ModuleFactory as j, type CompanyInterface as k, type FeatureInterface as l, type ModuleInterface as m, type NotificationInput as n, type RoleInterface as o, type UserInput as p };

package/dist/request-GBLBPYFM.js

@@ -0,0 +1,8 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunk3ZPK4QOBjs = require('./chunk-3ZPK4QOB.js');
+require('./chunk-7QVYU63E.js');
+
+
+exports.serverRequest = _chunk3ZPK4QOBjs.serverRequest;
+//# sourceMappingURL=request-GBLBPYFM.js.map

package/dist/request-GBLBPYFM.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/nextjs-jsonapi/nextjs-jsonapi/dist/request-GBLBPYFM.js"],"names":[],"mappings":"AAAA;AACE;AACF,sDAA4B;AAC5B,+BAA4B;AAC5B;AACE;AACF,uDAAC","file":"/home/runner/work/nextjs-jsonapi/nextjs-jsonapi/dist/request-GBLBPYFM.js"}

package/dist/request-XABCMU25.mjs

@@ -0,0 +1,8 @@
+import {
+  serverRequest
+} from "./chunk-KJ4ETLJB.mjs";
+import "./chunk-PAWJFY3S.mjs";
+export {
+  serverRequest
+};
+//# sourceMappingURL=request-XABCMU25.mjs.map