@object-ui/types 0.5.0 → 3.0.0

package/dist/permissions.d.ts

@@ -0,0 +1,150 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * @object-ui/types - Permission & RBAC Types
+ *
+ * Complete RBAC (Role-Based Access Control) type definitions for
+ * object/field/row-level permissions aligned with @objectstack/spec v2.0.1.
+ *
+ * @module permissions
+ * @packageDocumentation
+ */
+/** Standard CRUD permission actions */
+export type PermissionAction = 'create' | 'read' | 'update' | 'delete' | 'export' | 'import' | 'share' | 'admin';
+/** Permission effect */
+export type PermissionEffect = 'allow' | 'deny';
+/** Role definition for RBAC */
+export interface RoleDefinition {
+    /** Unique role identifier */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Role description */
+    description?: string;
+    /** Parent role for inheritance */
+    inherits?: string[];
+    /** Whether this is a system role */
+    system?: boolean;
+    /** Object-level permissions */
+    permissions: ObjectLevelPermission[];
+}
+/** Object-level permission assignment */
+export interface ObjectLevelPermission {
+    /** Target object name */
+    object: string;
+    /** Allowed actions */
+    actions: PermissionAction[];
+    /** Permission effect */
+    effect?: PermissionEffect;
+    /** Conditions for conditional permissions */
+    conditions?: PermissionCondition[];
+}
+/** Field-level permission */
+export interface FieldLevelPermission {
+    /** Target field name */
+    field: string;
+    /** Read permission */
+    read?: boolean;
+    /** Write permission */
+    write?: boolean;
+    /** Permission effect */
+    effect?: PermissionEffect;
+    /** Mask value for restricted fields (e.g., '****' for SSN) */
+    mask?: string;
+}
+/** Row-level permission (record-level security) */
+export interface RowLevelPermission {
+    /** Filter expression to scope visible records */
+    filter: string;
+    /** Actions allowed on matching records */
+    actions: PermissionAction[];
+    /** Description of the rule */
+    description?: string;
+}
+/** Permission condition for conditional access */
+export interface PermissionCondition {
+    /** Field to evaluate */
+    field: string;
+    /** Comparison operator */
+    operator: 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'contains' | 'is_null' | 'is_not_null';
+    /** Value to compare */
+    value: unknown;
+}
+/** Complete permission configuration for an object */
+export interface ObjectPermissionConfig {
+    /** Object name */
+    object: string;
+    /** Default permissions for unauthenticated users */
+    publicAccess?: PermissionAction[];
+    /** Role-based permissions */
+    roles: Record<string, {
+        actions: PermissionAction[];
+        fieldPermissions?: FieldLevelPermission[];
+        rowPermissions?: RowLevelPermission[];
+    }>;
+    /** Field-level permission defaults */
+    fieldDefaults?: FieldLevelPermission[];
+    /** Sharing rules */
+    sharingRules?: SharingRuleConfig[];
+}
+/** Sharing rule configuration */
+export interface SharingRuleConfig {
+    /** Rule name */
+    name: string;
+    /** Share with type */
+    type: 'role' | 'user' | 'group' | 'public';
+    /** Target entity (role name, user ID, group name) */
+    entity: string;
+    /** Permitted actions */
+    actions: PermissionAction[];
+    /** Filter to scope which records are shared */
+    filter?: string;
+}
+/** Permission check result */
+export interface PermissionCheckResult {
+    /** Whether the action is allowed */
+    allowed: boolean;
+    /** Reason for denial */
+    reason?: string;
+    /** Applicable field restrictions */
+    fieldRestrictions?: FieldLevelPermission[];
+    /** Row filter to apply */
+    rowFilter?: string;
+}
+/** Permission context for evaluating permissions */
+export interface PermissionContext {
+    /** Current user */
+    user: {
+        id: string;
+        roles: string[];
+        groups?: string[];
+        [key: string]: unknown;
+    };
+    /** Target object */
+    object: string;
+    /** Target action */
+    action: PermissionAction;
+    /** Target record (for row-level checks) */
+    record?: Record<string, unknown>;
+    /** Target field (for field-level checks) */
+    field?: string;
+}
+/** Permission guard configuration for UI components */
+export interface PermissionGuardConfig {
+    /** Required permission */
+    permission: string | PermissionAction;
+    /** Target object */
+    object?: string;
+    /** Fallback behavior when denied */
+    fallback?: 'hide' | 'disable' | 'redirect' | 'custom';
+    /** Custom fallback component type */
+    fallbackComponent?: string;
+    /** Redirect path for 'redirect' fallback */
+    redirectPath?: string;
+}
+//# sourceMappingURL=permissions.d.ts.map

package/dist/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../src/permissions.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAMH,uCAAuC;AACvC,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;AAEjH,wBAAwB;AACxB,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,MAAM,CAAC;AAEhD,+BAA+B;AAC/B,MAAM,WAAW,cAAc;IAC7B,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,oCAAoC;IACpC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,+BAA+B;IAC/B,WAAW,EAAE,qBAAqB,EAAE,CAAC;CACtC;AAED,yCAAyC;AACzC,MAAM,WAAW,qBAAqB;IACpC,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,wBAAwB;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,6CAA6C;IAC7C,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACpC;AAED,6BAA6B;AAC7B,MAAM,WAAW,oBAAoB;IACnC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,sBAAsB;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,uBAAuB;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,wBAAwB;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,mDAAmD;AACnD,MAAM,WAAW,kBAAkB;IACjC,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,EAAE,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,GAAG,aAAa,CAAC;IAChH,uBAAuB;IACvB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,sDAAsD;AACtD,MAAM,WAAW,sBAAsB;IACrC,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE;QACpB,OAAO,EAAE,gBAAgB,EAAE,CAAC;QAC5B,gBAAgB,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC1C,cAAc,CAAC,EAAE,kBAAkB,EAAE,CAAC;KACvC,CAAC,CAAC;IACH,sCAAsC;IACtC,aAAa,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACvC,oBAAoB;IACpB,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;CACpC;AAED,iCAAiC;AACjC,MAAM,WAAW,iBAAiB;IAChC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC3C,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB;IACxB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,8BAA8B;AAC9B,MAAM,WAAW,qBAAqB;IACpC,oCAAoC;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,wBAAwB;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAC3C,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,oDAAoD;AACpD,MAAM,WAAW,iBAAiB;IAChC,mBAAmB;IACnB,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;IACF,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,MAAM,EAAE,gBAAgB,CAAC;IACzB,2CAA2C;IAC3C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,uDAAuD;AACvD,MAAM,WAAW,qBAAqB;IACpC,0BAA0B;IAC1B,UAAU,EAAE,MAAM,GAAG,gBAAgB,CAAC;IACtC,oBAAoB;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;IACtD,qCAAqC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB"}

package/dist/permissions.js

@@ -0,0 +1,8 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export {};

package/dist/tenant.d.ts

@@ -0,0 +1,138 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * @object-ui/types - Multi-Tenancy Types
+ *
+ * Type definitions for multi-tenant architecture support including
+ * tenant isolation, scoped queries, and custom branding.
+ *
+ * @module tenant
+ * @packageDocumentation
+ */
+import type { Theme } from './theme';
+/** Tenant isolation strategy */
+export type TenantIsolationStrategy = 'database' | 'schema' | 'row' | 'hybrid';
+/** Tenant status */
+export type TenantStatus = 'active' | 'suspended' | 'pending' | 'archived';
+/** Tenant plan/tier */
+export type TenantPlan = 'free' | 'starter' | 'professional' | 'enterprise' | 'custom';
+/** Tenant definition */
+export interface TenantConfig {
+    /** Unique tenant identifier */
+    id: string;
+    /** Tenant display name */
+    name: string;
+    /** Tenant slug (URL-friendly identifier) */
+    slug: string;
+    /** Tenant status */
+    status: TenantStatus;
+    /** Subscription plan */
+    plan?: TenantPlan;
+    /** Tenant domain (for custom domain support) */
+    domain?: string;
+    /** Data isolation strategy */
+    isolation: TenantIsolationStrategy;
+    /** Custom branding */
+    branding?: TenantBranding;
+    /** Feature flags */
+    features?: Record<string, boolean>;
+    /** Usage limits */
+    limits?: TenantLimits;
+    /** Tenant metadata */
+    metadata?: Record<string, unknown>;
+    /** Created timestamp */
+    createdAt?: string;
+    /** Updated timestamp */
+    updatedAt?: string;
+}
+/** Tenant branding configuration */
+export interface TenantBranding {
+    /** Company logo URL */
+    logo?: string;
+    /** Favicon URL */
+    favicon?: string;
+    /** Primary brand color */
+    primaryColor?: string;
+    /** Secondary brand color */
+    secondaryColor?: string;
+    /** Custom theme override */
+    theme?: Partial<Theme>;
+    /** Custom CSS */
+    customCSS?: string;
+    /** Company name displayed in UI */
+    companyName?: string;
+    /** Support email */
+    supportEmail?: string;
+    /** Custom login page background */
+    loginBackground?: string;
+    /** Email templates branding */
+    emailBranding?: {
+        headerLogo?: string;
+        footerText?: string;
+        primaryColor?: string;
+    };
+}
+/** Tenant usage limits */
+export interface TenantLimits {
+    /** Maximum number of users */
+    maxUsers?: number;
+    /** Maximum storage in bytes */
+    maxStorage?: number;
+    /** Maximum API calls per day */
+    maxAPICallsPerDay?: number;
+    /** Maximum objects/tables */
+    maxObjects?: number;
+    /** Maximum records per object */
+    maxRecordsPerObject?: number;
+    /** Maximum file upload size in bytes */
+    maxFileSize?: number;
+}
+/** Tenant context for runtime use */
+export interface TenantContext {
+    /** Current tenant configuration */
+    tenant: TenantConfig;
+    /** Whether the user is a tenant admin */
+    isTenantAdmin: boolean;
+    /** Resolved branding (merged with defaults) */
+    branding: TenantBranding;
+    /** Active feature flags */
+    features: Record<string, boolean>;
+}
+/** Tenant resolution strategy */
+export type TenantResolutionStrategy = 'subdomain' | 'path' | 'header' | 'query' | 'cookie' | 'custom';
+/** Tenant provider configuration */
+export interface TenantProviderConfig {
+    /** How to resolve tenant from request */
+    resolution: TenantResolutionStrategy;
+    /** Custom resolution function name */
+    customResolver?: string;
+    /** Header name for 'header' strategy */
+    headerName?: string;
+    /** Query parameter name for 'query' strategy */
+    queryParam?: string;
+    /** Cookie name for 'cookie' strategy */
+    cookieName?: string;
+    /** Default tenant ID for fallback */
+    defaultTenantId?: string;
+    /** Enable tenant caching */
+    caching?: boolean;
+    /** Cache TTL in seconds */
+    cacheTTL?: number;
+}
+/** Scoped query configuration for tenant isolation */
+export interface TenantScopedQueryConfig {
+    /** Tenant ID field name in records */
+    tenantField: string;
+    /** Whether to auto-inject tenant filter */
+    autoFilter: boolean;
+    /** Objects excluded from tenant scoping */
+    excludedObjects?: string[];
+    /** Whether to enforce tenant scope on writes */
+    enforceOnWrite: boolean;
+}
+//# sourceMappingURL=tenant.d.ts.map

package/dist/tenant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenant.d.ts","sourceRoot":"","sources":["../src/tenant.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAMrC,gCAAgC;AAChC,MAAM,MAAM,uBAAuB,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE/E,oBAAoB;AACpB,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;AAE3E,uBAAuB;AACvB,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,YAAY,GAAG,QAAQ,CAAC;AAEvF,wBAAwB;AACxB,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,wBAAwB;IACxB,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,sBAAsB;IACtB,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,oBAAoB;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,mBAAmB;IACnB,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,sBAAsB;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,oCAAoC;AACpC,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACvB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mCAAmC;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mCAAmC;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+BAA+B;IAC/B,aAAa,CAAC,EAAE;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,0BAA0B;AAC1B,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6BAA6B;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,wCAAwC;IACxC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qCAAqC;AACrC,MAAM,WAAW,aAAa;IAC5B,mCAAmC;IACnC,MAAM,EAAE,YAAY,CAAC;IACrB,yCAAyC;IACzC,aAAa,EAAE,OAAO,CAAC;IACvB,+CAA+C;IAC/C,QAAQ,EAAE,cAAc,CAAC;IACzB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED,iCAAiC;AACjC,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEvG,oCAAoC;AACpC,MAAM,WAAW,oBAAoB;IACnC,yCAAyC;IACzC,UAAU,EAAE,wBAAwB,CAAC;IACrC,sCAAsC;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gDAAgD;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qCAAqC;IACrC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,sDAAsD;AACtD,MAAM,WAAW,uBAAuB;IACtC,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,UAAU,EAAE,OAAO,CAAC;IACpB,2CAA2C;IAC3C,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,gDAAgD;IAChD,cAAc,EAAE,OAAO,CAAC;CACzB"}

package/dist/tenant.js

@@ -0,0 +1,8 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export {};