strapi-relation-names 1.2.2 → 1.3.0

package/dist/server/src/index.d.ts

@@ -1,12 +1,12 @@
 declare const _default: {
     register: ({ strapi }: {
-        strapi: import('@strapi/types/dist/core').Strapi;
+        strapi: import("@strapi/types/dist/core").Strapi;
     }) => void;
     bootstrap: ({ strapi }: {
-        strapi: import('@strapi/types/dist/core').Strapi;
+        strapi: import("@strapi/types/dist/core").Strapi;
     }) => void;
     destroy: ({ strapi }: {
-        strapi: import('@strapi/types/dist/core').Strapi;
+        strapi: import("@strapi/types/dist/core").Strapi;
     }) => void;
     config: {
         default: {
@@ -14,11 +14,13 @@ declare const _default: {
         };
         validator: (config: unknown) => asserts config is {
             collections: string[];
+            locale?: string;
+            timeZone?: string;
         };
     };
     controllers: {
         settings: ({ strapi }: {
-            strapi: import('@strapi/types/dist/core').Strapi;
+            strapi: import("@strapi/types/dist/core").Strapi;
         }) => {
             find(ctx: any): Promise<void>;
             update(ctx: any): Promise<any>;
@@ -29,12 +31,18 @@ declare const _default: {
             type: string;
             routes: any[];
         };
+        /**
+         * Plugin server methods
+         */
         admin: () => {
             type: string;
             routes: {
                 method: string;
                 path: string;
                 handler: string;
+                /**
+                 * Plugin server methods
+                 */
                 config: {
                     policies: string[];
                 };
@@ -43,20 +51,21 @@ declare const _default: {
     };
     services: {
         'relation-labels': ({ strapi }: {
-            strapi: import('@strapi/types/dist/core').Strapi;
+            strapi: import("@strapi/types/dist/core").Strapi;
         }) => {
             decorateCollectionResults: (ctx: any, sourceUid: string, results: unknown[]) => Promise<unknown[]>;
             decorateConfiguration: (data: any, sourceUid: string) => Promise<any>;
+            sanitizeConfigurationUpdate: (configuration: any) => any;
             decorateRelationResults: (ctx: any, sourceUid: string, targetField: string, results: unknown[]) => Promise<unknown[]>;
-            compileTemplate: (template: string, targetSchema: import('./services/utils/relation-labels').SchemaLike | undefined, resolveSchema?: import('./services/utils/relation-labels').SchemaResolver) => import('./services/utils/relation-labels').CompiledTemplate | null;
-            parseTemplate: (template: string) => string[] | null;
-            renderTemplate: (compiled: import('./services/utils/relation-labels').CompiledTemplate, values: Record<string, unknown>) => string;
+            compileTemplate: (template: string, targetSchema: import("./services/utils/relation-labels").TemplateSchema, resolveSchema?: import("./services/utils/relation-labels").SchemaResolver) => import("./services/utils/relation-labels").CompiledTemplate;
+            parseTemplate: (template: string) => string[];
+            renderTemplate: (compiled: import("./services/utils/relation-labels").CompiledTemplate, values: Record<string, unknown>, context?: import("../../shared/template").TransformContext) => string;
         };
         settings: ({ strapi }: {
-            strapi: import('@strapi/types/dist/core').Strapi;
+            strapi: import("@strapi/types/dist/core").Strapi;
         }) => {
-            get(): Promise<import('./types').RelationNamesSettings>;
-            set(value: unknown): Promise<import('./types').RelationNamesSettings>;
+            get(): Promise<import("./types").RelationNamesSettings>;
+            set(value: unknown): Promise<import("./types").RelationNamesSettings>;
         };
     };
     contentTypes: {};

package/dist/server/src/register.d.ts

@@ -1,4 +1,4 @@
-import { Core } from '@strapi/strapi';
+import type { Core } from '@strapi/strapi';
 declare const register: ({ strapi }: {
     strapi: Core.Strapi;
 }) => void;

package/dist/server/src/services/index.d.ts

@@ -1,19 +1,20 @@
 declare const _default: {
     'relation-labels': ({ strapi }: {
-        strapi: import('@strapi/types/dist/core').Strapi;
+        strapi: import("@strapi/types/dist/core").Strapi;
     }) => {
         decorateCollectionResults: (ctx: any, sourceUid: string, results: unknown[]) => Promise<unknown[]>;
         decorateConfiguration: (data: any, sourceUid: string) => Promise<any>;
+        sanitizeConfigurationUpdate: (configuration: any) => any;
         decorateRelationResults: (ctx: any, sourceUid: string, targetField: string, results: unknown[]) => Promise<unknown[]>;
-        compileTemplate: (template: string, targetSchema: import('./utils/relation-labels').SchemaLike | undefined, resolveSchema?: import('./utils/relation-labels').SchemaResolver) => import('./utils/relation-labels').CompiledTemplate | null;
-        parseTemplate: (template: string) => string[] | null;
-        renderTemplate: (compiled: import('./utils/relation-labels').CompiledTemplate, values: Record<string, unknown>) => string;
+        compileTemplate: (template: string, targetSchema: import("./utils/relation-labels").TemplateSchema, resolveSchema?: import("./utils/relation-labels").SchemaResolver) => import("./utils/relation-labels").CompiledTemplate;
+        parseTemplate: (template: string) => string[];
+        renderTemplate: (compiled: import("./utils/relation-labels").CompiledTemplate, values: Record<string, unknown>, context?: import("../../../shared/template").TransformContext) => string;
     };
     settings: ({ strapi }: {
-        strapi: import('@strapi/types/dist/core').Strapi;
+        strapi: import("@strapi/types/dist/core").Strapi;
     }) => {
-        get(): Promise<import('../types').RelationNamesSettings>;
-        set(value: unknown): Promise<import('../types').RelationNamesSettings>;
+        get(): Promise<import("../types").RelationNamesSettings>;
+        set(value: unknown): Promise<import("../types").RelationNamesSettings>;
     };
 };
 export default _default;

package/dist/server/src/services/relation-labels.d.ts

@@ -1,18 +1,15 @@
-import { Core } from '@strapi/strapi';
-import { SchemaLike } from './utils/relation-labels';
-type Populate = Record<string, true | {
-    populate: Populate;
-}>;
-declare const buildPopulate: (placeholders: string[]) => Populate | undefined;
+import type { Core } from '@strapi/strapi';
+import { buildPopulate } from './utils/relation-hydration';
 declare const relationLabels: ({ strapi }: {
     strapi: Core.Strapi;
 }) => {
     decorateCollectionResults: (ctx: any, sourceUid: string, results: unknown[]) => Promise<unknown[]>;
     decorateConfiguration: (data: any, sourceUid: string) => Promise<any>;
+    sanitizeConfigurationUpdate: (configuration: any) => any;
     decorateRelationResults: (ctx: any, sourceUid: string, targetField: string, results: unknown[]) => Promise<unknown[]>;
-    compileTemplate: (template: string, targetSchema: SchemaLike | undefined, resolveSchema?: import('./utils/relation-labels').SchemaResolver) => import('./utils/relation-labels').CompiledTemplate | null;
-    parseTemplate: (template: string) => string[] | null;
-    renderTemplate: (compiled: import('./utils/relation-labels').CompiledTemplate, values: Record<string, unknown>) => string;
+    compileTemplate: (template: string, targetSchema: import("./utils/relation-labels").TemplateSchema, resolveSchema?: import("./utils/relation-labels").SchemaResolver) => import("./utils/relation-labels").CompiledTemplate;
+    parseTemplate: (template: string) => string[];
+    renderTemplate: (compiled: import("./utils/relation-labels").CompiledTemplate, values: Record<string, unknown>, context?: import("../../../shared/template").TransformContext) => string;
 };
 export { buildPopulate };
 export { compileTemplate, parseTemplate, renderTemplate } from './utils/relation-labels';

package/dist/server/src/services/settings.d.ts

@@ -1,5 +1,5 @@
-import { Core } from '@strapi/strapi';
-import { RelationNamesSettings } from '../types';
+import type { Core } from '@strapi/strapi';
+import type { RelationNamesSettings } from '../types';
 declare const normalizeSettings: (value: unknown, collections?: string[]) => RelationNamesSettings;
 declare const settings: ({ strapi }: {
     strapi: Core.Strapi;

package/dist/server/src/services/utils/relation-hydration.d.ts

@@ -0,0 +1,7 @@
+import type { Core } from '@strapi/strapi';
+import type { RelationRuntime } from './relation-labels';
+export type Populate = Record<string, true | {
+    populate: Populate;
+}>;
+export declare const buildPopulate: (placeholders: string[]) => Populate | undefined;
+export declare const hydrateValues: (strapi: Core.Strapi, ctx: any, runtime: RelationRuntime, values: Record<string, unknown>[]) => Promise<Map<Record<string, unknown>, Record<string, unknown>>>;

package/dist/server/src/services/utils/relation-labels.d.ts

@@ -1,29 +1,11 @@
-export type SchemaAttribute = {
-    type?: string;
-    target?: string;
-    component?: string;
-    components?: string[];
-    relation?: string;
-    private?: boolean;
-};
-export type SchemaLike = {
+export type { CompiledTemplate, SchemaResolver, TemplateAttribute as SchemaAttribute, TemplateSchema, } from '../../../../shared/template';
+export { compileTemplate, getPathValue, isRecord, parseTemplate, parseTemplateAst, renderTemplate, } from '../../../../shared/template';
+export type SchemaLike = import('../../../../shared/template').TemplateSchema & {
     uid: string;
     modelType?: string;
-    attributes?: Record<string, SchemaAttribute>;
-};
-export type SchemaResolver = (uid: string) => SchemaLike | undefined;
-export type CompiledTemplate = {
-    template: string;
-    placeholders: string[];
-    displayField: string;
 };
-export type RelationRuntime = CompiledTemplate & {
+export type RelationRuntime = import('../../../../shared/template').CompiledTemplate & {
     sourceUid: string;
     targetUid: string;
     originalMainField: string;
 };
-export declare const isRecord: (value: unknown) => value is Record<string, unknown>;
-export declare const getPathValue: (value: unknown, path: string) => unknown;
-export declare const parseTemplate: (template: string) => string[] | null;
-export declare const compileTemplate: (template: string, targetSchema: SchemaLike | undefined, resolveSchema?: SchemaResolver) => CompiledTemplate | null;
-export declare const renderTemplate: (compiled: CompiledTemplate, values: Record<string, unknown>) => string;

package/dist/server/src/services/utils/relation-runtime.d.ts

@@ -0,0 +1,6 @@
+import type { Core } from '@strapi/strapi';
+import type { RelationNamesSettings } from '../../types';
+import type { TransformContext } from '../../../../shared/template';
+import { type RelationRuntime } from './relation-labels';
+export declare const getRuntime: (strapi: Core.Strapi, settings: RelationNamesSettings, sourceUid: string, targetField: string, userAbility: unknown, transformContext: TransformContext) => Promise<RelationRuntime | null>;
+export declare const getTransformContext: (strapi: Core.Strapi) => TransformContext;

package/dist/server/src/services/utils/relation-values.d.ts

@@ -1,4 +1,4 @@
-import { RelationRuntime } from './relation-labels';
+import type { RelationRuntime } from './relation-labels';
 export declare const getIdentity: (value: Record<string, unknown>, modelType?: string) => unknown;
 export declare const matchesRelation: (source: Record<string, unknown>, candidate: Record<string, unknown>, targetModelType?: string) => boolean;
 export declare const applyLabel: (value: Record<string, unknown>, hydrated: Record<string, unknown>, runtime: RelationRuntime) => Record<string, unknown>;

package/dist/shared/records.d.ts

@@ -0,0 +1 @@
+export declare const isRecord: (value: unknown) => value is Record<string, unknown>;

package/dist/shared/template.d.ts

@@ -0,0 +1,55 @@
+export { isRecord } from './records';
+export type TemplateAttribute = {
+    type?: string;
+    target?: string;
+    targetModel?: string;
+    component?: string;
+    components?: string[];
+    relation?: string;
+    private?: boolean;
+};
+export type TemplateSchema = {
+    uid?: string;
+    attributes?: Record<string, TemplateAttribute>;
+};
+export type SchemaResolver = (uid: string) => TemplateSchema | undefined;
+export type TemplateExpression = {
+    path: string;
+    transforms: string[];
+};
+export type TemplateToken = {
+    type: 'text';
+    value: string;
+} | {
+    type: 'expression';
+    expression: TemplateExpression;
+};
+export type TemplateAst = {
+    tokens: TemplateToken[];
+    expressions: TemplateExpression[];
+};
+export type TransformContext = {
+    locale?: string;
+    timeZone?: string;
+};
+export type TransformDefinition = {
+    accepts: (fieldType: string | undefined) => boolean;
+    apply: (value: unknown, context: TransformContext) => unknown;
+};
+export type CompiledTemplate = {
+    template: string;
+    placeholders: string[];
+    displayField: string;
+    tokens?: TemplateToken[];
+    expressions?: TemplateExpression[];
+    transformContext?: TransformContext;
+};
+export declare const TRANSFORMS: Readonly<Record<string, TransformDefinition>>;
+export declare const getPathValue: (value: unknown, path: string) => unknown;
+export declare const parseTemplateAst: (template: string) => TemplateAst | null;
+export declare const parseTemplate: (template: string) => string[] | null;
+export declare const compileTemplate: (template: string, targetSchema: TemplateSchema | undefined, resolveSchema?: SchemaResolver) => CompiledTemplate | null;
+export declare const renderTemplate: (compiled: CompiledTemplate, values: Record<string, unknown>, context?: TransformContext) => string;
+export declare const validateTemplate: (template: string, attributes: Record<string, TemplateAttribute> | undefined, schemas?: ReadonlyMap<string, TemplateSchema>) => string | null;
+export declare const getAvailableFields: (schema: TemplateSchema | undefined, schemas: ReadonlyMap<string, TemplateSchema>, prefix?: string, ancestors?: Set<string>) => string[];
+export declare const getPlaceholders: (template: string) => string[] | null;

package/package.json

@@ -1,17 +1,11 @@
 {
   "name": "strapi-relation-names",
+  "version": "1.3.0",
   "description": "Display Strapi relations with clear, customizable labels built from your content fields",
+  "keywords": [],
   "license": "MIT",
   "author": "Christoph Tupi <christoph.tupi@gmail.com>",
-  "keywords": [],
   "type": "commonjs",
-  "version": "1.2.2",
-  "strapi": {
-    "kind": "plugin",
-    "name": "strapi-relation-names",
-    "displayName": "Strapi Relation Names",
-    "description": "Display Strapi relations with clear, customizable labels built from your content fields"
-  },
   "exports": {
     "./package.json": "./package.json",
     "./strapi-admin": {
@@ -34,22 +28,22 @@
   ],
   "scripts": {
     "build": "strapi-plugin build",
-    "watch": "strapi-plugin watch",
-    "watch:link": "strapi-plugin watch:link",
-    "verify": "strapi-plugin verify",
+    "fmt": "oxfmt",
+    "lint": "oxlint",
     "prepare": "lefthook install",
     "test": "vitest run",
-    "test:ts:front": "tsc -p admin/tsconfig.json",
     "test:ts:back": "tsc -p server/tsconfig.json",
-    "lint": "oxlint",
-    "fmt": "oxfmt"
+    "test:ts:front": "tsc -p admin/tsconfig.json",
+    "verify": "strapi-plugin verify",
+    "watch": "strapi-plugin watch",
+    "watch:link": "strapi-plugin watch:link"
   },
   "devDependencies": {
-    "@strapi/design-system": "^2.2.4",
-    "@strapi/icons": "^2.2.4",
-    "@strapi/sdk-plugin": "^6.1.1",
-    "@strapi/strapi": "^5.52.3",
-    "@strapi/typescript-utils": "^5.52.3",
+    "@strapi/design-system": "^2.0.0-rc.11",
+    "@strapi/icons": "^2.0.0-rc.11",
+    "@strapi/sdk-plugin": "^5.0.0",
+    "@strapi/strapi": "^5.0.0",
+    "@strapi/typescript-utils": "^5.0.0",
     "@types/react": "^18.3.31",
     "@types/react-dom": "^18.3.7",
     "lefthook": "^2.1.12",
@@ -64,14 +58,20 @@
     "vitest": "^5.0.0"
   },
   "peerDependencies": {
-    "@strapi/design-system": "^2.2.4",
-    "@strapi/icons": "^2.2.4",
-    "@strapi/sdk-plugin": "^6.1.1",
-    "@strapi/strapi": "^5.52.3",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "react-intl": "^6.8.9",
-    "react-router-dom": "^6.30.6",
-    "styled-components": "^6.5.3"
+    "@strapi/design-system": "^2.0.0-rc.11",
+    "@strapi/icons": "^2.0.0-rc.11",
+    "@strapi/sdk-plugin": "^5.0.0",
+    "@strapi/strapi": "^5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "react-intl": "^6.6.2",
+    "react-router-dom": "^6.0.0",
+    "styled-components": "^6.0.0"
+  },
+  "strapi": {
+    "kind": "plugin",
+    "name": "strapi-relation-names",
+    "displayName": "Strapi Relation Names",
+    "description": "Display Strapi relations with clear, customizable labels built from your content fields"
   }
 }